Run

Cancel the pipeline behind a /v1/run request

Resolves the request to its pipeline and cancels the WHOLE pipeline — under append mode that includes every other live request appended to it, each of which receives its own run.cancelled webhook and is listed in run_requests. 409 not_cancellable_yet while the request is still ingesting (no pipeline_id yet); 200 with already: true on a request that is already terminal. Requires write scope.

post/v1/run/{id}/cancel

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/run/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

reasonstring

Optional free text recorded on the run and carried by the run.cancelled webhook.

Response

Cancel result (idempotent: already: true on a run that was already terminal).

idstring uuid required
statusstring required

The run's status after the call: cancelled, or the terminal state it already had.

alreadyboolean required

True when the run was already terminal and nothing changed.

cancelled_atstring date-time nullable required
run_requestsstring[] required

run_ids of the /v1/run requests cancelled along with the pipeline.

run_idstring uuid

Present on /v1/run/{id}/cancel: the request that was cancelled.

pipeline_idstring uuid nullable

Present on /v1/run/{id}/cancel.

Changes

No recorded changes to this operation across all 1 revision of this API.