Schedules

Create schedule

Create a cron Schedule bound to a saved Agent version. Idempotency-Key is required. input must be non-empty. The model credential (model_provider, or your API key when omitted) is stored encrypted and used for scheduled runs.

post/v1/schedules

Request

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

namestring required
descriptionstring
agent_idstring required
agent_versioninteger

Omit to pin the current Agent version.

inputstring required
modelstring

Response

Schedule created

idstring required

Service (svc_) or Schedule (sch_) ID.

kind'service' | 'schedule' required
namestring required
descriptionstring required
agent_idstring required
agent_versioninteger required

Pinned Agent version.

inputstring required
modelstring
status'active' | 'paused' | 'archived' required
row_versioninteger required

Schedule row_version also advances after every scheduled tick.

next_run_atstring date-time
created_atstring date-time required
updated_atstring date-time required

Changes

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