Get a run

GET

/v1/runs/:id

GET

/v1/runs/:id

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

1 {
2   "object": "string",
3   "id": "string",
4   "status": "queued",
5   "expiresAt": "string",
6   "statusUrl": "string",
7   "files": [
8     {
9       "id": "string",
10       "name": "string",
11       "status": "string",
12       "error": "string"
13     }
14   ],
15   "file": {
16     "id": "string",
17     "name": "string",
18     "status": "string",
19     "error": "string"
20   },
21   "error": {
22     "code": "string",
23     "message": "string"
24   },
25   "metadata": {},
26   "tasks": [
27     {
28       "id": "string",
29       "title": "string",
30       "url": "string"
31     }
32   ],
33   "config": {
34     "schema": {}
35   },
36   "output": {
37     "citations": {},
38     "documents": [
39       {
40         "fileId": "string",
41         "name": "string",
42         "status": "string",
43         "error": "string",
44         "citations": {}
45       }
46     ]
47   }
48 }

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
`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 until a step parks for a human — which returns immediately with status: "needs_input" and tasks[]. ?include=evidence is accepted and does nothing: citations are always present when the run was grounded.

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.

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](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/extract) | | `par_` | Parse | [POST /v1/parse](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/parse) | | `rdr_` | Redaction | [POST /v1/redact](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/redact) | | `flr_` | Form fill | [POST /v1/fill](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/fill) | | `sgr_` | E-signature | [POST /v1/sign](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/sign) | | `plr_` | Pipeline | [POST /v1/pipeline](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/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 until a step parks for a human — which returns immediately with `status: "needs_input"` and `tasks[]`. `?include=evidence` is accepted and does nothing: citations are always present when the run was grounded. <Note> An expired run answers `410 run_expired` during its grace window and `404` afterwards. Call [POST /v1/runs/{id}/keep](https://docs.cloudraker.com/api/cloud-raker-api/runs/keep-run) before expiry to hold onto the files for good. </Note>

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired>=1 character

Query parameters

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