Parse a document (async)

Queues a document and returns straight away with a document_id. Get the result by polling Get a document, or receive it on a webhook as soon as it is ready.

Use this for large or multi-page documents, batches, and any client with a short request timeout. The page count and your balance are checked before the document is queued, so those errors are returned immediately.

Authorization

tokenAuth

Authorization<token>

Your API token prefixed with Token , for example Token YOUR_API_TOKEN.

In: header

Path Parameters

slug*string

Your parser's slug. Copy it from the endpoint URL in the parser's Integrations tab. It must be your own parser, not a library template.

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Send either file or file_url.

file?file

The document to parse. PDF, PNG, JPG, JPEG or WEBP.

Formatbinary

file_url?string

A URL SimplyParse can download the document from without authentication, such as a pre-signed S3 URL. Used instead of file.

Formaturi

environment?string

A label such as production or staging. It is stored with the document and decides which webhooks receive the result.

Default"default"

has_multiple_entries?string

Send true when one file contains several records (for example a PDF of many invoices). Each record becomes its own entry. Requires a parser with a unique field.

Default"false"

Value in

"true"
"false"

Response Body

`application/json`

curl -X POST "https://example.com/dapi/v1/parser/a1b2c3/parse/async"

{  "status": "success",  "code": "document_queued",  "message": "Document queued for processing",  "data": {    "document_id": "3c59dc04-8a4e-4d6b-9f3e-7a1f0e2b5c66",    "job_id": "6512bd43-d9ca-4e6f-b1d2-0c7a8e3f4b21"  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

Document queued

No file sent

`application/json`

`application/json`

`application/json`

`application/json`