Skip to main content
POST
Run Document Agent

Authorizations

X-API-Key
string
header
required

Cookies

wos-session
string
datalab_active_team
string

Body

multipart/form-data
processor
string
required

A published agent processor address, e.g. 'cp_abc123' or 'cp_abc123@2.0'. Omit the version to run the newest published one.

file_url
string | null

Optional file URL (http/https). If provided, the server will download and process it.

verification_effort
string
default:fast

How much verification the agent run does before it may finish. One of 'fast', 'balanced', 'accurate'.

return_images
boolean
default:false

Return the run's images inline as base64 (parse render shapes only).

skip_cache
boolean
default:false

Skip the cache and re-run the request.

webhook_url
string | null

Optional webhook URL to call when the request is complete.

processing_location
string | null

Optional residency region override (e.g. us, eu). When provided, use file_url or direct-upload; multipart uploads are rejected. When omitted, the request uses the team's configured residency and profile.

file
file | null

Input PDF, image, office document (doc/docx/ppt/pptx), HTML, EPUB, or spreadsheet (xlsx/xlsm/xls/ods/csv) file, uploaded as multipart form data. Office documents are converted to PDF before the agent runs; spreadsheets are processed per-sheet.

Response

Successful Response

request_id
string
required

The ID of the request. This ID can be used to check the status of the request.

request_check_url
string
required

The URL to check the status of the request and get results.

success
boolean
default:true

Whether the request was successful.

error
string | null

If the request was not successful, this will contain an error message.

versions

A dictionary of the versions of the libraries used in the request.

checkpoint_reused
boolean | null

True when this run automatically reused a checkpoint from a previous run of the same file, so the conversion step is not re-billed. Absent/None otherwise.