Schedule

Schedule Agent Message

client.agents.schedule.create(, , ?): ScheduleCreateResponse { id, next_scheduled_at }

POST/v1/agents/{agent_id}/schedule

List Scheduled Agent Messages

client.agents.schedule.list(, ?, ?): ScheduleListResponse { has_next_page, scheduled_messages }

GET/v1/agents/{agent_id}/schedule

Retrieve Scheduled Agent Message

client.agents.schedule.retrieve(, , ?): ScheduleRetrieveResponse { id, agent_id, message, 2 more }

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

Delete Scheduled Agent Message

client.agents.schedule.delete(, , ?): ScheduleDeleteResponse { success }

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

ModelsExpand Collapse

ScheduleCreateResponse { id, next_scheduled_at }

id: string

next_scheduled_at?: string

ScheduleListResponse { has_next_page, scheduled_messages }

has_next_page: boolean

scheduled_messages: Array<ScheduledMessage>

id: string

agent_id: string

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

messages: Array<Message>

content: Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } > | string

One of the following:

Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } >

UnionMember0 { text, signature, type }

text: string

signature?: string | null

type?: "text"

UnionMember1 { source, type }

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

data: string

media_type: string

detail?: string

type?: "base64"

type: "image"

string

role: "user" | "assistant" | "system"

One of the following:

"user"

"assistant"

"system"

name?: string

otid?: string

sender_id?: string

type?: "message"

callback_url?: string

include_return_message_types?: Array<"system_message" | "user_message" | "assistant_message" | 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?: number

next_scheduled_time: string | null

schedule: UnionMember0 { scheduled_at, type } | UnionMember1 { cron_expression, type }

One of the following:

UnionMember0 { scheduled_at, type }

scheduled_at: number

type?: "one-time"

UnionMember1 { cron_expression, type }

cron_expression: string

type: "recurring"

ScheduleRetrieveResponse { id, agent_id, message, 2 more }

id: string

agent_id: string

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

messages: Array<Message>

content: Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } > | string

One of the following:

Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } >

UnionMember0 { text, signature, type }

text: string

signature?: string | null

type?: "text"

UnionMember1 { source, type }

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

data: string

media_type: string

detail?: string

type?: "base64"

type: "image"

string

role: "user" | "assistant" | "system"

One of the following:

"user"

"assistant"

"system"

name?: string

otid?: string

sender_id?: string

type?: "message"

callback_url?: string

include_return_message_types?: Array<"system_message" | "user_message" | "assistant_message" | 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?: number

next_scheduled_time: string | null

schedule: UnionMember0 { scheduled_at, type } | UnionMember1 { cron_expression, type }

One of the following:

UnionMember0 { scheduled_at, type }

scheduled_at: number

type?: "one-time"

UnionMember1 { cron_expression, type }

cron_expression: string

type: "recurring"

ScheduleDeleteResponse { success }

success: true