Schedule

Schedule Agent Message

POST/v1/agents/{agent_id}/schedule

List Scheduled Agent Messages

GET/v1/agents/{agent_id}/schedule

Retrieve Scheduled Agent Message

GET/v1/agents/{agent_id}/schedule/{scheduled_message_id}

Delete Scheduled Agent Message

DELETE/v1/agents/{agent_id}/schedule/{scheduled_message_id}

ModelsExpand Collapse

ScheduleCreateResponse object { id, next_scheduled_at }

id: string

next_scheduled_at: optional string

ScheduleListResponse object { has_next_page, scheduled_messages }

has_next_page: boolean

scheduled_messages: array of object { id, agent_id, message, 2 more }

id: string

agent_id: string

message: object { messages, callback_url, include_return_message_types, max_steps }

messages: array of object { content, role, name, 3 more }

content: array of object { text, signature, type } or object { source, type } or string

One of the following:

array of object { text, signature, type } or object { source, type }

One of the following:

object { text, signature, type }

text: string

signature: optional string

type: optional "text"

object { source, type }

source: object { data, media_type, detail, type }

data: string

media_type: string

detail: optional string

type: optional "base64"

type: "image"

string

role: "user" or "assistant" or "system"

One of the following:

"user"

"assistant"

"system"

name: optional string

otid: optional string

sender_id: optional string

type: optional "message"

callback_url: optional string

include_return_message_types: optional array of "system_message" or "user_message" or "assistant_message" or 6 more

One of the following:

"system_message"

"user_message"

"assistant_message"

"reasoning_message"

"hidden_reasoning_message"

"tool_call_message"

"tool_return_message"

"approval_request_message"

"approval_response_message"

max_steps: optional number

next_scheduled_time: string

schedule: object { scheduled_at, type } or object { cron_expression, type }

One of the following:

object { scheduled_at, type }

scheduled_at: number

type: optional "one-time"

object { cron_expression, type }

cron_expression: string

type: "recurring"

ScheduleRetrieveResponse object { id, agent_id, message, 2 more }

id: string

agent_id: string

message: object { messages, callback_url, include_return_message_types, max_steps }

messages: array of object { content, role, name, 3 more }

content: array of object { text, signature, type } or object { source, type } or string

One of the following:

array of object { text, signature, type } or object { source, type }

One of the following:

object { text, signature, type }

text: string

signature: optional string

type: optional "text"

object { source, type }

source: object { data, media_type, detail, type }

data: string

media_type: string

detail: optional string

type: optional "base64"

type: "image"

string

role: "user" or "assistant" or "system"

One of the following:

"user"

"assistant"

"system"

name: optional string

otid: optional string

sender_id: optional string

type: optional "message"

callback_url: optional string

include_return_message_types: optional array of "system_message" or "user_message" or "assistant_message" or 6 more

One of the following:

"system_message"

"user_message"

"assistant_message"

"reasoning_message"

"hidden_reasoning_message"

"tool_call_message"

"tool_return_message"

"approval_request_message"

"approval_response_message"

max_steps: optional number

next_scheduled_time: string

schedule: object { scheduled_at, type } or object { cron_expression, type }

One of the following:

object { scheduled_at, type }

scheduled_at: number

type: optional "one-time"

object { cron_expression, type }

cron_expression: string

type: "recurring"

ScheduleDeleteResponse object { success }

success: true