Schedules

Cancel schedule run

Request cancellation of a pending Run. Idempotency-Key is required and the body must be {}. A finished Run is returned unchanged (202). While the Run has no Session yet (session_id null) the call returns 409 conflict; while the Run input is still being delivered it returns 409 session_input_pending. Wait and retry with the same Idempotency-Key.

post/v1/schedules/{schedule_id}/runs/{run_id}/cancel

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/v1/schedules/{schedule_id}/runs/{run_id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring required

Required. 1-128 characters without leading or trailing whitespace. Reuse the same key and body when retrying.

Request body

EmptyObject required

Response

Cancellation accepted

idstring required

Run ID. Treat as opaque.

source_type'service' | 'schedule' required
source_idstring required
source_versioninteger required
agent_idstring required
agent_versioninteger required
trigger_source'manual' | 'scheduled' required
scheduled_atstring date-time
status'pending' | 'succeeded' | 'failed' | 'cancelled' | 'skipped' required

skipped is used when a scheduled tick finds a pending Run.

session_idstring nullable required

Session created for this Run; null until the Session exists.

error_codestring

For example session_creation_rejected, execution_failed, schedule_configuration_invalid, concurrency_limit (skipped ticks), or an admission code such as spending_limit_exceeded.

created_atstring date-time required
updated_atstring date-time required

Changes

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