Create Schedule

POST/v1/schedules

Create a Schedule that runs a pinned Agent version on a cron expression. Idempotency-Key is required. The model credential (model_provider, or your calling API key) is stored encrypted and used for every scheduled run.

Headers

stringIdempotency-Keyrequired

1-128 characters, no leading or trailing whitespace. Reuse the same key and body when retrying; the same key with a different body returns 409.

Request body

Strict JSON object.

stringnamerequired

Up to 200 characters.

stringagent_idrequired

Saved Agent ID. The Agent must be active and ready.

Optional<integer>agent_version

Agent version to pin. Omit to pin the current version at creation time.

stringinputrequired

Input sent on every run. Required and non-empty, up to 256 KiB.

Optional<string>description

Up to 16384 characters.

Optional<string>model

Default model override.

objectschedulerequired

{"cron": "<5-field cron>", "timezone": "<IANA name>"}. timezone defaults to UTC. Seconds are not supported; an expression with no match in the next 366 days returns 400.

Optional<object>model_provider

Model credential stored encrypted for scheduled runs. Omit to store your calling API key.

curl -X POST https://api.sandbase.ai/v1/schedules \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Idempotency-Key: create-schedule-1" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily digest",
    "agent_id": "agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60",
    "input": "Summarize the previous day of AI agent news.",
    "schedule": {
      "cron": "0 9 * * 1-5",
      "timezone": "Asia/Shanghai"
    }
  }'

Response201 Created

{
  "id": "sch_7e3b1c58-2a9d-5e4f-b6c1-8d0a2f4e6b17",
  "kind": "schedule",
  "name": "Daily digest",
  "description": "",
  "agent_id": "agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60",
  "agent_version": 3,
  "input": "Summarize the previous day of AI agent news.",
  "status": "active",
  "row_version": 1,
  "schedule": {
    "cron": "0 9 * * 1-5",
    "timezone": "Asia/Shanghai"
  },
  "next_run_at": "2026-10-07T01:00:00Z",
  "created_at": "2026-10-06T08:00:00Z",
  "updated_at": "2026-10-06T08:00:00Z"
}