Developer docs

API and embedded upload documentation

Use dataPdf from your own systems with API keys for server integrations and a hosted embed flow for browser experiences.

Fastest path

Presign, upload, confirm

Authentication

X-API-Key for server calls

Completion signal

Email notification by default

API keys

API keys belong to an individual dataPdf account. They are intended for backend services, scheduled jobs, and internal tools.

Generate and revoke keys from your account without creating a separate organization workspace.
Send the key in the X-API-Key header when calling protected API endpoints.
All page usage is billed to the account that owns the key, with optional company details used for invoicing.

Presign and confirm upload flow

The API mirrors the application upload flow so integrations stay simple while large files still upload directly to storage.

Request a presigned upload URL from /api/upload/presign.
Upload the file directly to the returned storage URL.
Call /api/upload/confirm?start=true to register the file and begin processing.

Embedded upload widget

For browser-based integrations, use a hosted embed flow instead of exposing API keys in client-side code.

Users authenticate with their normal dataPdf account inside the widget.
The browser should receive a short-lived embed token, not a long-lived API key.
Use the embed flow when you want low integration effort on a customer-facing website.

Security boundaries

Keep API keys on the server side and use session or embed-token auth for browser contexts.

Do not place API keys in JavaScript bundles, iframe URLs, or public markup.
Rotate keys if they are no longer needed or if a backend integration changes owners.
Use account-level billing details when invoices need to show company information.

Minimal integration sequence

Most teams only need the upload flow plus email completion to start automating PDF intake.

1. Create an API key in your dataPdf account settings
2. POST /api/upload/presign with X-API-Key
3. Upload the file to the returned storage URL
4. POST /api/upload/confirm?start=true
5. Wait for the completion email or fetch the result later

Current locale: en. Add localized screenshots and code samples later.