For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI ReferenceWebhooks Reference
DocumentationAPI ReferenceWebhooks Reference
  • Document Processing
    • POSTDocument Created
    • POSTDocument Processed
    • POSTDocument Approved
    • POSTDocument Discarded
  • File Processing
    • POSTFile Processed
    • POSTFile Rejected
  • Import Processing
    • POSTImport Processed
LogoLogo
Document Processing

Document Created

Payload
1{
2  "id": "675e1a2b8f7d06899790871d",
3  "timestamp": 1702649400000,
4  "version": "1.2",
5  "data": {},
6  "type": "document.created"
7}
Document created and webhook fired just before transitioning to `processing` status. Contains minimal information available at creation time. **⚠️ Important:** The document will be empty at this stage with status `processing`. API requests for this document will return a 202 Accepted status indicating the document is reserved but not yet available for retrieval. Full document data will be available after the `document.processed` event when status becomes `processed`. Please refer to the latest documentation for payload details.
Was this page helpful?

Document Processed

Next
Built with

Document created and webhook fired just before transitioning to processing status. Contains minimal information available at creation time.

⚠️ Important: The document will be empty at this stage with status processing. API requests for this document will return a 202 Accepted status indicating the document is reserved but not yet available for retrieval. Full document data will be available after the document.processed event when status becomes processed.

Please refer to the latest documentation for payload details.

Payload

The payload of this webhook request is an object.
idstringRequired

Unique identifier for this event (use for idempotent processing)

timestampdouble or stringRequired
Event timestamp
versionstringRequired
Version of the event schema
dataobjectOptional

Document structure returned in webhooks and GET /documents/:id endpoint.

Data Format:

  • Data fields contain direct values: {"total": 100}
  • Validation errors include validation, info, and paths fields
  • Document type can be a built-in type name, custom type alias, or ObjectId for custom types
typeenumOptional
Allowed values:
urlstringOptional

URL field (typically empty string for security)

Response

200
Webhook received successfully