Agents
Get Agent by ID
Delete Agent by ID
List Agents
Handle Agent RPC by ID
Get Agent by Name
Delete Agent by Name
Handle Agent RPC by Name
Register Build
ModelsExpand Collapse
AgentRpcRequest object { method, params, id, jsonrpc }
params: object { name, params, task_metadata } or object { task_id, task_name } or object { task_id, task_name } or 2 more
The parameters for the agent RPC request
CreateTaskRequest object { name, params, task_metadata }
name: optional string
Optional human-readable name for the task. When set it must be globally unique. task/create is get-or-create by name: reusing an existing name returns the existing task (with its prior history) instead of creating a new one, so omit name (or make it unique, e.g. by appending a UUID) whenever each call should produce a fresh task.
SendMessageRequest object { content, stream, task_id, 2 more }
The message that was sent to the agent
TextContent object { author, content, attachments, 3 more }
SendEventRequest object { content, task_id, task_name }
The content to send to the event
TextContent object { author, content, attachments, 3 more }
AgentRpcResponse object { result, id, error, jsonrpc }
The result of the agent RPC request
array of TaskMessage { content, task_id, id, 3 more }
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageStart object { content, index, parent_task_message, type }
Event for starting a streaming message
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageDelta object { delta, index, parent_task_message, type }
Event for streaming chunks of content
Delta for text updates
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageFull object { content, index, parent_task_message, type }
Event for streaming the full content
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageDone object { index, parent_task_message, type }
Event for indicating the task is done
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
Task object { id, cleaned_at, created_at, 6 more }
Event object { id, agent_id, sequence_id, 3 more }
The content of the event
TextContent object { author, content, attachments, 3 more }
AgentRpcResult = array of TaskMessage { content, task_id, id, 3 more } or object { content, index, parent_task_message, type } or object { delta, index, parent_task_message, type } or 4 more
Event for starting a streaming message
array of TaskMessage { content, task_id, id, 3 more }
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageStart object { content, index, parent_task_message, type }
Event for starting a streaming message
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageDelta object { delta, index, parent_task_message, type }
Event for streaming chunks of content
Delta for text updates
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageFull object { content, index, parent_task_message, type }
Event for streaming the full content
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
StreamTaskMessageDone object { index, parent_task_message, type }
Event for indicating the task is done
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
Task object { id, cleaned_at, created_at, 6 more }
Event object { id, agent_id, sequence_id, 3 more }
The content of the event
TextContent object { author, content, attachments, 3 more }
TaskMessageContent = TextContent { author, content, attachments, 3 more } or ReasoningContent { author, summary, content, 2 more } or DataContent { author, data, style, type } or 2 more
TextContent object { author, content, attachments, 3 more }
TaskMessageDelta = TextDelta { text_delta, type } or DataDelta { data_delta, type } or ToolRequestDelta { name, tool_call_id, arguments_delta, type } or 3 more
Delta for text updates
TaskMessageUpdate = object { content, index, parent_task_message, type } or object { delta, index, parent_task_message, type } or object { content, index, parent_task_message, type } or object { index, parent_task_message, type }
Event for starting a streaming message
Start object { content, index, parent_task_message, type }
Event for starting a streaming message
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
Delta object { delta, index, parent_task_message, type }
Event for streaming chunks of content
Delta for text updates
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
Full object { content, index, parent_task_message, type }
Event for streaming the full content
TextContent object { author, content, attachments, 3 more }
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
Done object { index, parent_task_message, type }
Event for indicating the task is done
Represents a message in the agent system.
This entity is used to store messages in MongoDB, with each message associated with a specific task.
The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.
TextContent object { author, content, attachments, 3 more }
AgentsDeployments
Create Deployment
List Deployments
Get Deployment
Delete Deployment
Promote Deployment
Preview RPC
ModelsExpand Collapse
AgentsSchedules
Create Run Schedule
List Run Schedules
Get Run Schedule
Update Run Schedule
Delete Run Schedule
Pause Run Schedule
Resume Run Schedule
Trigger Run Schedule
Skip Run Schedule Action
Unskip Run Schedule Action
Get Run Schedule By Name
Update Run Schedule By Name
Delete Run Schedule By Name
Pause Run Schedule By Name
Resume Run Schedule By Name
Trigger Run Schedule By Name
ModelsExpand Collapse
ScheduleCreateResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleListResponse object { run_schedules, total }
Response model for listing run schedules.
run_schedules: array of object { id, agent_id, initial_input, 20 more }
The list of run schedules.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleRetrieveResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleUpdateResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
SchedulePauseResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleResumeResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleTriggerResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleSkipResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleUnskipResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleRetrieveByNameResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleUpdateByNameResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
SchedulePauseByNameResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleResumeByNameResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
ScheduleTriggerByNameResponse object { id, agent_id, initial_input, 20 more }
Response model describing a scheduled agent run.
creator_principal: optional object { account_id, principal_type, service_account_id, user_id }
Credential-free creator identity stored with the schedule.
Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator context used only for AuthZ and ownership at fire time.
live_data_available: optional boolean
Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.