Pipelines

Cancel a running pipeline

Stops the run: no new phase starts, documents still in flight finish their current step and are marked cancelled, finished documents keep their results, every live /v1/run request on the pipeline is cancelled with it (each gets its own run.cancelled webhook). The pipeline keeps accepting new submissions and reruns afterwards. Requires write scope.

post/v1/pipelines/{id}/cancel

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/pipelines/{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.