DocumentFlow
DocumentFlow

API Endpoints

API Token

Enter your API token to test the endpoints. This token will be used for all examples on this page.

POST
/v1/documents/process

Submit a document for processing. The API will analyze the document and extract the relevant information based on the document type.

Parameters

Name
Type
Required
Description
urlstring
Yes
The URL of the document to process
typestring
Yes
The type of document (e.g., 'invoice', 'receipt')

Response

Code Examples

curl -X POST https://api.documentflow.com/v1/documents/process \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com/document.pdf",
  "type": "invoice"
}'
GET
/v1/documents/{id}

Retrieve the current status and results of a processed document.

Parameters

Name
Type
Required
Description
idstring
Yes
The ID of the document to retrieve

Response

Code Examples

curl https://api.documentflow.com/v1/documents/doc_123456 \
-H "Authorization: Bearer YOUR_API_KEY"