Quickstart
You need:- The URL base of the API.
- A API key (
x-api-key). See Authentication. - A document PDF, DOCX, CSV, XLSX, PPTX, TXT or ZIP.
Convert a local file
text/markdown. If the service returns 202 instead of 200, the backends are temporarily saturated and your request was automatically queued: see Jobs for the polling pattern.
Convert from signed URL
If your document is already in storage (S3, R2, Supabase, GCS, Azure Blob), it is more efficient to send the signed URL instead of uploading the binary:output_url).
Convert by uploading the file as a form
If your client already handlesmultipart/form-data (for example a web form with <input type="file">), use POST /convert:
Primeros pasos recomendados
- Starts with
mode=fast(this is the default) unless the document has complex tables or irregular layout. - Review the response headers (
X-Token-Saved-Estimate,X-Conversion-Ms) to understand the real savings in your use case. See Response and headers. - If you are converting the same document several times, save
ETagand resend withIf-None-Matchto avoid reconversion. See Cache. - If PDF is large and you are only interested in part of it, try
POST /pdf/indexfirst before converting the entire document. - Handle
202: In high traffic, API can automatically queue your request. The SDK/client must know how to poll/jobs/{id}. See Jobs.
Modos
Detail in Conversion modes.
Useful headers
The response includes observability headers:
Complete reference in Response and headers.
Common mistakes when starting
401: headerx-api-keyis missing or the key is invavalid. Check Authentication.415:content-typeorcontent-encodingis not a supported one. In/convert/rawonlygziporzstdis accepted as compression.422: in/convert/from-urlthe fieldurlis missing in the JSON body or in the query.413: The document exceeds the size/page limit. See Weights and limits.
Siguiente paso
Summary of API
All endpoints, base URL and response model at a glance.
