Run Document Agent
Authorizations
Body
A published agent processor address, e.g. 'cp_abc123' or 'cp_abc123@2.0'. Omit the version to run the newest published one.
Optional file URL (http/https). If provided, the server will download and process it.
How much verification the agent run does before it may finish. One of 'fast', 'balanced', 'accurate'.
Return the run's images inline as base64 (parse render shapes only).
Skip the cache and re-run the request.
Optional webhook URL to call when the request is complete.
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.
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
The ID of the request. This ID can be used to check the status of the request.
The URL to check the status of the request and get results.
Whether the request was successful.
If the request was not successful, this will contain an error message.
A dictionary of the versions of the libraries used in the request.
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.