Cancel run

Stop a run that is still going: one run_pipeline, assemble_video or edit_asset started. Use it when the person asks to cancel, stop or kill a render, including "stop, that's wrong" about one they can see running. A render that is rendering stops once its current step finishes (status "cancelling", then "cancelled" in get_run); one still waiting to start is closed at once and costs nothing. Steps that already finished keep their output and are not refunded. Leave out runId to cancel the pipeline's newest running run. Needs the pipelines:run scope.

post/api/v1/tools/cancel_run

Request

  • Base URL: https://www.trezalabs.com
  • URL: https://www.trezalabs.com/api/v1/tools/cancel_run
  • Auth: HTTP bearer

Request body

pipelineIdstring required

The pipelineId the run was started under (for assemble_video and edit_asset, the one they returned).

runIdstring

The run to stop. Omit for the newest run still going.

Response

The tool's result.

object required

Changes

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