Get a run

GET

https://api.cloudraker.com/v1/runs/:id

GET

/v1/runs/:id

curl https://api.cloudraker.com/v1/runs/id \
     -H "Authorization: Bearer <token>"

{
  "config": {
    "schema": {}
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "expiresAt": "string",
  "file": {
    "error": "string",
    "id": "string",
    "name": "string",
    "status": "string"
  },
  "files": [
    {
      "error": "string",
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "id": "string",
  "metadata": {},
  "object": "string",
  "output": {
    "citations": {},
    "citationsOmitted": true,
    "documents": [
      {
        "citations": {},
        "error": "string",
        "fileId": "string",
        "jsonUrl": "string",
        "markdown": "string",
        "markdownUrl": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "jsonUrl": "string",
    "markdown": "string",
    "markdownUrl": "string"
  },
  "status": "queued",
  "statusUrl": "string"
}

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:

Prefix	Run	Created by
`exr_`	Extraction	POST /v1/extract
`par_`	Parse	POST /v1/parse
`rdr_`	Redaction	POST /v1/redact
`flr_`	Form fill	POST /v1/fill
`sgr_`	E-signature	POST /v1/sign
`clr_`	Classification	POST /v1/classify
`spr_`	Split	POST /v1/split
`plr_`	Pipeline	POST /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

V1ParseRunobject

V1RedactRunobject

V1FillRunobject

V1SignRunobject

V1PipelineRunobject

Errors

404

Not Found Error

410

Gone Error

429

Too Many Requests Error