Skip to main content

Cancel Scheduled Chat run

Request cooperative cancellation of one active occurrence.

POST/api/scheduled/{schedule_id}/runs/{occurrence_id}/cancel
HTTP referenceScope authenticated user session (developer API keys blocked)Updated October 15, 2026

This page documents the canonical HTTP contract for this endpoint.

Authenticate with the signed-in user session using a bearer token or the accessToken cookie. Developer API keys are blocked. Definitions, runs, and attention belong to the current user; current workspace membership is rechecked before accessing saved resources. Lists may include your own work across accessible workspaces.

A cancellation request can return cancel_requested. Poll the occurrence to observe its terminal outcome; it does not undo already-completed effects.

Path parameters

  • schedule_idrequired

    string

    Exact Scheduled Chat definition ID returned by create or list.

  • occurrence_idrequired

    string

    Exact durable occurrence ID returned by run-now or list runs.

Body parameters

  • reason · optional

    string

    1–1,000 character reason; defaults to Cancelled by user. The whole request body may be omitted.

Errors

StatusMeaning
401A valid signed-in user session is required.
403Developer API keys are blocked or workspace access is unavailable.
404The owner-scoped schedule, run, attention item, or referenced resource is unavailable.
409The version, status transition, authority, or active occurrence conflicts with this request.
422Invalid request fields, recurrence, or resource references.

Docs