Parse a document or audio file
Turns any document or audio file into clean markdown plus structured JSON — audio becomes a transcript.
Nothing else runs: parsing is the whole job, and output carries markdownUrl and jsonUrl (signed, ~1 hour). Add ?output=inline for a one-call response that also carries markdown and parsed json. Inline source is capped at 1 MiB across both artifacts; larger output keeps the URLs only. Point file at a URL, or at a file you already registered with POST /v1/files.
Choosing an engine with file.processing:
Waiting for the result
Sync by default: the call holds open until the run finishes, up to ?wait= seconds (default 60, max 120, 0 returns immediately).
Learn more: Parsing guide
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
How many seconds to hold the request open waiting for the run to finish.
Finishing inside the window returns 200 with the full run; running past it returns 202 with a statusUrl to poll. Send 0 to skip waiting entirely and always get the 202.
How parsed source content is returned.
urls returns signed download URLs. inline also returns markdown and parsed JSON when their combined payload is at most 1 MiB; larger content falls back to the URLs only.
Request
An input file, given one of two ways.
{ "url": "…", "name"?: "…", "processing"?: "…" }— fetched over http(s) for this run and purged with it.{ "id": "…" }— a file you already registered withPOST /v1/files, reusable across runs and never re-parsed.
Arbitrary JSON you attach to the run and get back on every read of it.
Use it to carry your own identifiers — an order number, a customer id — so a webhook or a polled run reconciles without a lookup table. Capped at 10 KB serialized.
Where to deliver this run's events, given one of two ways.
{ "url": "…" }— a one-off https endpoint for this run only.{ "id": "whe_…" }— a saved endpoint fromPOST /v1/webhooks. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too.
Deliveries are at-least-once and signed — dedupe on eventId and verify against GET /v1/webhooks/jwks.json.
How long, in seconds, to keep this run and its files before purging them automatically.
The maximum is 604800 (7 days). The deadline comes back as expiresAt on every read of the run. Call POST /v1/runs/{id}/keep before then to clear the TTL and move the results into a space permanently.
E-signature runs are exempt — an envelope waits for its signers however long that takes.
Response
Where the run is in its life.
The last four are terminal.
Why the run failed. Present whenever status is failed, and only then.
code is the stable, snake_case reason (input_unavailable, parse_failed, …); message is the human-readable detail. Per-file and per-step failures are also reported in files[].error and, for a pipeline, steps[].error.
The parsed document. Present once status is processed.
Both links are signed and valid for about an hour: markdownUrl for the readable form, jsonUrl for the structured one. With ?output=inline, markdown and parsed json are included too when their combined payload is at most 1 MiB; larger content falls back to the URLs only.