Cancel a run

To stop a run you no longer need results from, cancel it, keeping in mind that cancellation is best-effort and can lose the race to a run that is about to finish anyway. cancel requests that a run stop. See Concepts for why a run can still complete after you cancel it. It never errors on a run that has already ended, so it is safe to call speculatively and to retry.

cancelled = client.agent.cancel(run_id)
print(cancelled.status)  # may already be "completed" if the run won the race

const cancelled = await client.agent.cancel(runId);
console.log(cancelled.status); // may already be "completed" if the run won the race

curl -X POST "https://api.seltz.ai/v1/agent/runs/$RUN_ID/cancel" \
  -H "x-api-key: $SELTZ_API_KEY"

When cancellation actually takes effect, the run has no output: status is cancelled, stop_reason is cancelled, and output’s fields stay unset.

Next steps

List runs: paging this org’s runs, newest first
Poll for completion: managing the wait yourself
Reference: endpoints, fields, limits and errors
Agent API Reference: full REST request and response specification

Getting Started

Web Tools

Data

Tutorials

Integrations

SDKs

Cancel a run

Next steps

​Next steps

Next steps