Skip to main content

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

The default response is 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:
Full detail in POST /convert/from-url, including anti-SSRF security and BYOS exit (output_url).

Convert by uploading the file as a form

If your client already handles multipart/form-data (for example a web form with <input type="file">), use POST /convert:
See POST /convert for full details.

Primeros pasos recomendados

  1. Starts with mode=fast (this is the default) unless the document has complex tables or irregular layout.
  2. Review the response headers (X-Token-Saved-Estimate, X-Conversion-Ms) to understand the real savings in your use case. See Response and headers.
  3. If you are converting the same document several times, save ETag and resend with If-None-Match to avoid reconversion. See Cache.
  4. If PDF is large and you are only interested in part of it, try POST /pdf/index first before converting the entire document.
  5. 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: header x-api-key is missing or the key is invavalid. Check Authentication.
  • 415: content-type or content-encoding is not a supported one. In /convert/raw only gzip or zstd is accepted as compression.
  • 422: in /convert/from-url the field url is missing in the JSON body or in the query.
  • 413: The document exceeds the size/page limit. See Weights and limits.
Complete list in Errors.

Siguiente paso

Summary of API

All endpoints, base URL and response model at a glance.