List all schedules for a (agent, user) pair.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/agents/string/users/string/schedules"

{
  "$schema": "/api/v1/schemas/ListSchedulesOutputBody.json",
  "schedules": [
    {
      "$schema": "/api/v1/schemas/ScheduleDTO.json",
      "active_window": "string",
      "cadence": "string",
      "cadence_type": "string",
      "check_type": "string",
      "created_at": "string",
      "enabled": true,
      "ends_at": "string",
      "intent": "string",
      "inventory_item_id": "string",
      "metadata": "string",
      "next_fire_at": "string",
      "schedule_id": "string",
      "starts_at": "string",
      "timezone": "string",
      "updated_at": "string"
    }
  ]
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Create a recurring schedule for a user.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active_window?unknown

Optional quiet-hours/days filter: {hours:{start,end},days_of_week}.

cadence*unknown

Cadence spec: {simple:{...}}|{cron:"..."} with required timezone field.

check_type*string

ends_at?string

RFC3339.

intent*string

inventory_item_id?string

metadata?unknown

starts_at?string

RFC3339.

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/agents/string/users/string/schedules" \  -H "Content-Type: application/json" \  -d '{    "cadence": null,    "check_type": "string",    "intent": "string"  }'

{
  "$schema": "/api/v1/schemas/CreateScheduleOutputBody.json",
  "enabled": true,
  "next_fire_at": "string",
  "next_fire_at_local": "string",
  "schedule_id": "string"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Fetch a single schedule by ID.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

scheduleId*string

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/agents/string/users/string/schedules/string"

{
  "$schema": "/api/v1/schemas/ScheduleDTO.json",
  "active_window": "string",
  "cadence": "string",
  "cadence_type": "string",
  "check_type": "string",
  "created_at": "string",
  "enabled": true,
  "ends_at": "string",
  "intent": "string",
  "inventory_item_id": "string",
  "metadata": "string",
  "next_fire_at": "string",
  "schedule_id": "string",
  "starts_at": "string",
  "timezone": "string",
  "updated_at": "string"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Partially update a schedule. Recomputes next_fire_at only when cadence/active_window/starts_at change.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

scheduleId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active_window?unknown

cadence?unknown

check_type?string

enabled?boolean

ends_at?string

intent?string

metadata?unknown

starts_at?string

Response Body

`application/json`

`application/problem+json`

curl -X PATCH "https://loading/api/v1/agents/string/users/string/schedules/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "$schema": "/api/v1/schemas/ScheduleDTO.json",
  "active_window": "string",
  "cadence": "string",
  "cadence_type": "string",
  "check_type": "string",
  "created_at": "string",
  "enabled": true,
  "ends_at": "string",
  "intent": "string",
  "inventory_item_id": "string",
  "metadata": "string",
  "next_fire_at": "string",
  "schedule_id": "string",
  "starts_at": "string",
  "timezone": "string",
  "updated_at": "string"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Delete a schedule. Idempotent — missing IDs return 204.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

scheduleId*string

Response Body

`application/problem+json`

curl -X DELETE "https://loading/api/v1/agents/string/users/string/schedules/string"

Empty

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Preview the next N allowed fire times (honors active_window). Does not mutate state.

Authorization

AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

userId*string

scheduleId*string

Query Parameters

limit?integer

Default10

Formatint64

Range1 <= value <= 100

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/agents/string/users/string/schedules/string/upcoming"

{
  "$schema": "/api/v1/schemas/UpcomingScheduleOutputBody.json",
  "upcoming": [
    "string"
  ]
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Schedules

200application/json

422application/problem+json

500application/problem+json

503application/problem+json

200application/json

400application/problem+json

422application/problem+json

500application/problem+json

503application/problem+json

200application/json

404application/problem+json

422application/problem+json

500application/problem+json

503application/problem+json

200application/json

400application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

503application/problem+json

204

422application/problem+json

500application/problem+json

503application/problem+json

200application/json

404application/problem+json

422application/problem+json

500application/problem+json

503application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`