Skip to navigation

Get a run

View as Markdown

Returns a run’s status and, once it is processed, its result.

One route reads every kind of run. The response shape follows the id prefix:

PrefixRunCreated by
exr_ExtractionPOST /v1/extract
par_ParsePOST /v1/parse
rdr_RedactionPOST /v1/redact
flr_Form fillPOST /v1/fill
sgr_E-signaturePOST /v1/sign
clr_ClassificationPOST /v1/classify
spr_SplitPOST /v1/split
plr_PipelinePOST /v1/pipeline

A plr_ run additionally carries steps[] — a per-step status and result, keyed by the step id you were handed at create.

Long-polling. ?wait=<seconds> (0–120) holds the request until the run reaches a terminal state or needs external input. ?include=evidence is accepted and does nothing: citations are always present when the run was grounded.

Parsed source. Add ?output=inline when reading a parse or extraction run to include parsed markdown and JSON. The 1 MiB combined cap and URL-only fallback are identical to the create verbs.

An expired run answers 410 run_expired during its grace window and 404 afterwards. Call POST /v1/runs/{id}/keep before expiry to hold onto the files for good.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired>=1 character

Query parameters

outputenumOptionalDefaults to urls

Return parsed source inline for parse/extract runs when the combined source is at most 1 MiB; otherwise retain signed URLs only.

Allowed values:
includestringOptional
waitintegerOptional0-120Defaults to 0

Response

The run.
V1ExtractRunobject
OR
V1ParseRunobject
OR
V1RedactRunobject
OR
V1FillRunobject
OR
V1SignRunobject
OR
V1PipelineRunobject

Errors

400
Bad Request Error
404
Not Found Error
410
Gone Error
429
Too Many Requests Error