Queue a document for conversion with OCR and tables
submit_conversion_jobQueue a document up to 25 MB and 200 pages for conversion with OCR and tables.
Pass the file as base64 in content_base64, or as a download link in
file, and its name in filename (.pdf, .docx, .pptx, .xlsx, .html,
.htm or .txt). Returns job_id, status and result_url. Call
get_conversion_job with the job_id until status is succeeded or
failed. A conversion may take up to about 2 minutes.
Optional webhook_url: a public http or https URL that receives a POST
with the job's final state. The request carries
X-Appkit-Signature: sha256=<hex>, an HMAC-SHA256 of the raw body keyed
with the returned webhook_secret (shown only once). 3 delivery attempts.
Requires an API key. The credits are refunded if the job fails. The uploaded file is deleted when the job finishes. Results are kept for 7 days after submission.
Credits: 10 per call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | The file as a download link, instead of `content_base64`. In ChatGPT, pass the user's uploaded file here. Other clients can set `download_url` to a public https URL. | |
| filename | Yes | The file name with its extension (.pdf, .docx, .pptx, .xlsx, .html, .htm or .txt). The extension decides how the file is read. | |
| webhook_url | No | Optional. A public http or https URL that receives the job's final state. | |
| content_base64 | No | The file content, base64-encoded. Up to 25 MB before encoding. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||