Skip to navigation

Cancel a run

View as Markdown

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.

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
OR
V1ParseRunobject
OR
V1RedactRunobject
OR
V1FillRunobject
OR
V1SignRunobject
OR
V1PipelineRunobject

Errors

404
Not Found Error
410
Gone Error
429
Too Many Requests Error