Schedules
GET /api/orgs/{org_id}/agents/{agent_id}/schedules
Section titled “GET /api/orgs/{org_id}/agents/{agent_id}/schedules”List Agent Schedules
List all schedules for one agent, oldest first.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agent_id | path | string (uuid) | yes | |
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | ScheduleResponse[] |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/agents/{agent_id}/schedules
Section titled “POST /api/orgs/{org_id}/agents/{agent_id}/schedules”Create Schedule
Create a recurring cron schedule that fires this agent.
Requires ADMIN or OWNER role. cron_expr (standard 5-field) and
timezone (IANA) are validated together; an invalid combination
returns 422.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agent_id | path | string (uuid) | yes | |
| org_id | path | string (uuid) | yes |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
| cron_expr | string | yes | |
| enabled | boolean | no | |
| overlap_policy | ScheduleOverlapPolicy | no | |
| prompt | string | yes | |
| timezone | string | no |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Successful Response | ScheduleResponse |
| 422 | Validation Error | HTTPValidationError |
GET /api/orgs/{org_id}/schedules
Section titled “GET /api/orgs/{org_id}/schedules”List Org Schedules
List schedules in the org, each annotated with its agent’s name/slug.
Omit limit to get every schedule; total is the full count either way.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer | no | Max rows to return (1-100). Omit to return every row. |
| offset | query | integer | no | Rows to skip — pass the previous response’s next_offset. |
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | Page_ScheduleWithAgentResponse_ |
| 422 | Validation Error | HTTPValidationError |
GET /api/orgs/{org_id}/schedules/{schedule_id}
Section titled “GET /api/orgs/{org_id}/schedules/{schedule_id}”Get Schedule
Get a single schedule’s detail.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| schedule_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | ScheduleResponse |
| 422 | Validation Error | HTTPValidationError |
PATCH /api/orgs/{org_id}/schedules/{schedule_id}
Section titled “PATCH /api/orgs/{org_id}/schedules/{schedule_id}”Update Schedule
Update any of prompt/cron_expr/timezone/enabled/overlap_policy.
Requires ADMIN or OWNER role. Recomputes next_run_at when
cron_expr/timezone/enabled change; an invalid cron/timezone
combination returns 422.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| schedule_id | path | string (uuid) | yes |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
| cron_expr | string | no | |
| enabled | boolean | no | |
| overlap_policy | ScheduleOverlapPolicy | no | |
| prompt | string | no | |
| timezone | string | no |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | ScheduleResponse |
| 422 | Validation Error | HTTPValidationError |
DELETE /api/orgs/{org_id}/schedules/{schedule_id}
Section titled “DELETE /api/orgs/{org_id}/schedules/{schedule_id}”Delete Schedule
Soft-delete a schedule. Requires ADMIN or OWNER role.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| schedule_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 204 | Successful Response | |
| 422 | Validation Error | HTTPValidationError |
GET /api/orgs/{org_id}/schedules/{schedule_id}/runs
Section titled “GET /api/orgs/{org_id}/schedules/{schedule_id}/runs”List Schedule Runs
List the chats this schedule has fired (the correlation query), newest first.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| schedule_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | ScheduleRunResponse[] |
| 422 | Validation Error | HTTPValidationError |