Schedules

Trigger schedule run

Start a manual Run now. Idempotency-Key is required. input, model, and model_provider override the saved values for this Run only. Only one pending Run is allowed per Schedule.

post/v1/schedules/{schedule_id}/runs

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/v1/schedules/{schedule_id}/runs
  • 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

inputstring

Overrides the saved input for this Run. The effective input must be non-empty.

modelstring

Overrides the saved model for this Run.

Response

Run 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.