Cancel a run

POST

/v1/runs/:id/cancel

POST

/v1/runs/:id/cancel

$ curl -X POST https://api.cloudraker.com/v1/runs/id/cancel \
>      -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 }

Stops a run’s in-flight work and returns the run in its cancelled state.

Files and the TTL are untouched — the run still purges at expiresAt. To delete everything now, use DELETE /v1/runs/{id}.
Idempotent — cancelling an already-terminal run changes nothing and returns the current run body.

Stops a run's in-flight work and returns the run in its cancelled state. - **Files and the TTL are untouched** — the run still purges at `expiresAt`. To delete everything now, use [DELETE /v1/runs/{id}](https://docs.cloudraker.com/api/cloud-raker-api/runs/delete-run). - **Idempotent** — cancelling an already-terminal run changes nothing and returns the current run body.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired>=1 character

Response

The run after cancellation.

V1ExtractRunobject

V1ParseRunobject

V1RedactRunobject

V1FillRunobject

V1SignRunobject

V1PipelineRunobject

Errors

404

Not Found Error

410

Gone Error

429

Too Many Requests Error