API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Agents

Get Agent by ID

agents.retrieve(stragent_id) -> Agent

GET/agents/{agent_id}

Delete Agent by ID

agents.delete(stragent_id) -> DeleteResponse

DELETE/agents/{agent_id}

List Agents

agents.list(AgentListParams**kwargs) -> AgentListResponse

GET/agents

Handle Agent RPC by ID

agents.rpc(stragent_id, AgentRpcParams**kwargs) -> AgentRpcResponse

POST/agents/{agent_id}/rpc

Get Agent by Name

agents.retrieve_by_name(stragent_name) -> Agent

GET/agents/name/{agent_name}

Delete Agent by Name

agents.delete_by_name(stragent_name) -> DeleteResponse

DELETE/agents/name/{agent_name}

Handle Agent RPC by Name

agents.rpc_by_name(stragent_name, AgentRpcByNameParams**kwargs) -> AgentRpcResponse

POST/agents/name/{agent_name}/rpc

Register Build

agents.register_build(AgentRegisterBuildParams**kwargs) -> Agent

POST/agents/register-build

ModelsExpand Collapse

Literal["sync", "async", "agentic"]

One of the following:

"sync"

"async"

"agentic"

class Agent: …

id: str

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:

"sync"

"async"

"agentic"

created_at: datetime

The timestamp when the agent was created

formatdate-time

description: str

The description of the action.

name: str

The unique name of the agent.

updated_at: datetime

The timestamp when the agent was last updated

formatdate-time

agent_input_type: Optional[Literal["text", "json"]]

The type of input the agent expects.

One of the following:

"text"

"json"

production_deployment_id: Optional[str]

ID of the current production deployment.

registered_at: Optional[datetime]

The timestamp when the agent was last registered

formatdate-time

registration_metadata: Optional[Dict[str, object]]

The metadata for the agent’s registration.

status: Optional[Literal["Ready", "Failed", "Unknown", 3 more]]

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:

"Ready"

"Failed"

"Unknown"

"Deleted"

"Unhealthy"

"BuildOnly"

status_reason: Optional[str]

The reason for the status of the action.

class AgentRpcRequest: …

method: Literal["event/send", "task/create", "message/send", 2 more]

One of the following:

"event/send"

"task/create"

"message/send"

"task/cancel"

"task/interrupt"

params: Params

The parameters for the agent RPC request

One of the following:

class ParamsCreateTaskRequest: …

name: Optional[str]

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.

params: Optional[Dict[str, object]]

The parameters for the task. On a get-or-create by name, providing params overwrites the existing task’s params (it is not a pure read).

task_metadata: Optional[Dict[str, object]]

Caller-provided metadata to persist on the task row. Only applied at task creation; ignored if a task with this name already exists. Forwarded to the agent inside the ACP payload for backward compatibility.

class ParamsCancelTaskRequest: …

task_id: Optional[str]

The ID of the task to cancel. Either this or task_name must be provided.

task_name: Optional[str]

The name of the task to cancel. Either this or task_id must be provided.

class ParamsInterruptTaskRequest: …

task_id: Optional[str]

The ID of the task to interrupt. Either this or task_name must be provided.

task_name: Optional[str]

The name of the task to interrupt. Either this or task_id must be provided.

class ParamsSendMessageRequest: …

content: TaskMessageContent

The message that was sent to the agent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

stream: Optional[bool]

Whether to stream the response message back to the client

task_id: Optional[str]

The ID of the task that the message was sent to

task_name: Optional[str]

The name of the task that the message was sent to

task_params: Optional[Dict[str, object]]

The parameters for the task (only used when creating new tasks)

class ParamsSendEventRequest: …

content: Optional[TaskMessageContent]

The content to send to the event

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: Optional[str]

The ID of the task that the event was sent to

task_name: Optional[str]

The name of the task that the event was sent to

id: Optional[Union[int, str, null]]

One of the following:

int

str

jsonrpc: Optional[Literal["2.0"]]

class AgentRpcResponse: …

result: Optional[AgentRpcResult]

The result of the agent RPC request

One of the following:

List[TaskMessage]

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

class StreamTaskMessageStart: …

Event for starting a streaming message

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["start"]]

class StreamTaskMessageDelta: …

Event for streaming chunks of content

delta: Optional[TaskMessageDelta]

Delta for text updates

One of the following:

class TextDelta: …

Delta for text updates

text_delta: Optional[str]

type: Optional[Literal["text"]]

class DataDelta: …

Delta for data updates

data_delta: Optional[str]

type: Optional[Literal["data"]]

class ToolRequestDelta: …

Delta for tool request updates

name: str

tool_call_id: str

arguments_delta: Optional[str]

type: Optional[Literal["tool_request"]]

class ToolResponseDelta: …

Delta for tool response updates

name: str

tool_call_id: str

content_delta: Optional[str]

type: Optional[Literal["tool_response"]]

class ReasoningSummaryDelta: …

Delta for reasoning summary updates

summary_index: int

summary_delta: Optional[str]

type: Optional[Literal["reasoning_summary"]]

class ReasoningContentDelta: …

Delta for reasoning content updates

content_index: int

content_delta: Optional[str]

type: Optional[Literal["reasoning_content"]]

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["delta"]]

class StreamTaskMessageFull: …

Event for streaming the full content

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["full"]]

class StreamTaskMessageDone: …

Event for indicating the task is done

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["done"]]

class Task: …

id: str

cleaned_at: Optional[datetime]

created_at: Optional[datetime]

name: Optional[str]

params: Optional[Dict[str, object]]

status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]

One of the following:

"CANCELED"

"COMPLETED"

"FAILED"

"RUNNING"

"INTERRUPTED"

"TERMINATED"

"TIMED_OUT"

"DELETED"

status_reason: Optional[str]

task_metadata: Optional[Dict[str, object]]

updated_at: Optional[datetime]

class Event: …

id: str

The UUID of the event

agent_id: str

The UUID of the agent that the event belongs to

sequence_id: int

The sequence ID of the event

task_id: str

The UUID of the task that the event belongs to

content: Optional[TaskMessageContent]

The content of the event

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

created_at: Optional[datetime]

The timestamp of the event

formatdate-time

id: Optional[Union[int, str, null]]

One of the following:

int

str

error: Optional[object]

jsonrpc: Optional[Literal["2.0"]]

Optional[AgentRpcResult]

Event for starting a streaming message

One of the following:

List[TaskMessage]

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

class StreamTaskMessageStart: …

Event for starting a streaming message

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["start"]]

class StreamTaskMessageDelta: …

Event for streaming chunks of content

delta: Optional[TaskMessageDelta]

Delta for text updates

One of the following:

class TextDelta: …

Delta for text updates

text_delta: Optional[str]

type: Optional[Literal["text"]]

class DataDelta: …

Delta for data updates

data_delta: Optional[str]

type: Optional[Literal["data"]]

class ToolRequestDelta: …

Delta for tool request updates

name: str

tool_call_id: str

arguments_delta: Optional[str]

type: Optional[Literal["tool_request"]]

class ToolResponseDelta: …

Delta for tool response updates

name: str

tool_call_id: str

content_delta: Optional[str]

type: Optional[Literal["tool_response"]]

class ReasoningSummaryDelta: …

Delta for reasoning summary updates

summary_index: int

summary_delta: Optional[str]

type: Optional[Literal["reasoning_summary"]]

class ReasoningContentDelta: …

Delta for reasoning content updates

content_index: int

content_delta: Optional[str]

type: Optional[Literal["reasoning_content"]]

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["delta"]]

class StreamTaskMessageFull: …

Event for streaming the full content

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["full"]]

class StreamTaskMessageDone: …

Event for indicating the task is done

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["done"]]

class Task: …

id: str

cleaned_at: Optional[datetime]

created_at: Optional[datetime]

name: Optional[str]

params: Optional[Dict[str, object]]

status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]

One of the following:

"CANCELED"

"COMPLETED"

"FAILED"

"RUNNING"

"INTERRUPTED"

"TERMINATED"

"TIMED_OUT"

"DELETED"

status_reason: Optional[str]

task_metadata: Optional[Dict[str, object]]

updated_at: Optional[datetime]

class Event: …

id: str

The UUID of the event

agent_id: str

The UUID of the agent that the event belongs to

sequence_id: int

The sequence ID of the event

task_id: str

The UUID of the task that the event belongs to

content: Optional[TaskMessageContent]

The content of the event

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

created_at: Optional[datetime]

The timestamp of the event

formatdate-time

class DataDelta: …

Delta for data updates

data_delta: Optional[str]

type: Optional[Literal["data"]]

class ReasoningContentDelta: …

Delta for reasoning content updates

content_index: int

content_delta: Optional[str]

type: Optional[Literal["reasoning_content"]]

class ReasoningSummaryDelta: …

Delta for reasoning summary updates

summary_index: int

summary_delta: Optional[str]

type: Optional[Literal["reasoning_summary"]]

TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

TaskMessageDelta

Delta for text updates

One of the following:

class TextDelta: …

Delta for text updates

text_delta: Optional[str]

type: Optional[Literal["text"]]

class DataDelta: …

Delta for data updates

data_delta: Optional[str]

type: Optional[Literal["data"]]

class ToolRequestDelta: …

Delta for tool request updates

name: str

tool_call_id: str

arguments_delta: Optional[str]

type: Optional[Literal["tool_request"]]

class ToolResponseDelta: …

Delta for tool response updates

name: str

tool_call_id: str

content_delta: Optional[str]

type: Optional[Literal["tool_response"]]

class ReasoningSummaryDelta: …

Delta for reasoning summary updates

summary_index: int

summary_delta: Optional[str]

type: Optional[Literal["reasoning_summary"]]

class ReasoningContentDelta: …

Delta for reasoning content updates

content_index: int

content_delta: Optional[str]

type: Optional[Literal["reasoning_content"]]

TaskMessageUpdate

Event for starting a streaming message

One of the following:

class StreamTaskMessageStart: …

Event for starting a streaming message

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["start"]]

class StreamTaskMessageDelta: …

Event for streaming chunks of content

delta: Optional[TaskMessageDelta]

Delta for text updates

One of the following:

class TextDelta: …

Delta for text updates

text_delta: Optional[str]

type: Optional[Literal["text"]]

class DataDelta: …

Delta for data updates

data_delta: Optional[str]

type: Optional[Literal["data"]]

class ToolRequestDelta: …

Delta for tool request updates

name: str

tool_call_id: str

arguments_delta: Optional[str]

type: Optional[Literal["tool_request"]]

class ToolResponseDelta: …

Delta for tool response updates

name: str

tool_call_id: str

content_delta: Optional[str]

type: Optional[Literal["tool_response"]]

class ReasoningSummaryDelta: …

Delta for reasoning summary updates

summary_index: int

summary_delta: Optional[str]

type: Optional[Literal["reasoning_summary"]]

class ReasoningContentDelta: …

Delta for reasoning content updates

content_index: int

content_delta: Optional[str]

type: Optional[Literal["reasoning_content"]]

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["delta"]]

class StreamTaskMessageFull: …

Event for streaming the full content

content: TaskMessageContent

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["full"]]

class StreamTaskMessageDone: …

Event for indicating the task is done

index: Optional[int]

parent_task_message: Optional[TaskMessage]

Represents a message in the agent system.

This entity is used to store messages in MongoDB, with each message associated with a specific task.

content: TaskMessageContent

The content of the message. This content is not OpenAI compatible. These are messages that are meant to be displayed to the user.

One of the following:

class TextContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: str

The contents of the text message.

attachments: Optional[List[Attachment]]

Optional list of file attachments with structured metadata.

file_id: str

The unique ID of the attached file

name: str

The name of the file

size: int

The size of the file in bytes

type: str

The MIME type or content type of the file

format: Optional[TextFormat]

The format of the message. This is used by the client to determine how to display the message.

One of the following:

"markdown"

"plain"

"code"

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["text"]]

The type of the message, in this case text.

class ReasoningContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

summary: List[str]

A list of short reasoning summaries

content: Optional[List[str]]

The reasoning content or chain-of-thought text

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["reasoning"]]

The type of the message, in this case reasoning.

class DataContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

data: Dict[str, object]

The contents of the data message.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["data"]]

The type of the message, in this case data.

class ToolRequestContent: …

arguments: Dict[str, object]

The arguments to the tool.

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

name: str

The name of the tool that is being requested.

tool_call_id: str

The ID of the tool call that is being requested.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_request"]]

The type of the message, in this case tool_request.

class ToolResponseContent: …

author: MessageAuthor

The role of the messages author, in this case system, user, assistant, or tool.

One of the following:

"user"

"agent"

content: object

The result of the tool.

name: str

The name of the tool that is being responded to.

tool_call_id: str

The ID of the tool call that is being responded to.

is_error: Optional[bool]

Whether the tool call resulted in an error. None when the harness does not report a status.

style: Optional[MessageStyle]

The style of the message. This is used by the client to determine how to display the message.

One of the following:

"static"

"active"

type: Optional[Literal["tool_response"]]

The type of the message, in this case tool_response.

task_id: str

ID of the task this message belongs to

id: Optional[str]

The task message’s unique id

created_at: Optional[datetime]

The timestamp when the message was created

formatdate-time

streaming_status: Optional[Literal["IN_PROGRESS", "DONE"]]

One of the following:

"IN_PROGRESS"

"DONE"

updated_at: Optional[datetime]

The timestamp when the message was last updated

formatdate-time

type: Optional[Literal["done"]]

class TextDelta: …

Delta for text updates

text_delta: Optional[str]

type: Optional[Literal["text"]]

class ToolRequestDelta: …

Delta for tool request updates

name: str

tool_call_id: str

arguments_delta: Optional[str]

type: Optional[Literal["tool_request"]]

class ToolResponseDelta: …

Delta for tool response updates

name: str

tool_call_id: str

content_delta: Optional[str]

type: Optional[Literal["tool_response"]]

List[Agent]

id: str

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:

"sync"

"async"

"agentic"

created_at: datetime

The timestamp when the agent was created

formatdate-time

description: str

The description of the action.

name: str

The unique name of the agent.

updated_at: datetime

The timestamp when the agent was last updated

formatdate-time

agent_input_type: Optional[Literal["text", "json"]]

The type of input the agent expects.

One of the following:

"text"

"json"

production_deployment_id: Optional[str]

ID of the current production deployment.

registered_at: Optional[datetime]

The timestamp when the agent was last registered

formatdate-time

registration_metadata: Optional[Dict[str, object]]

The metadata for the agent’s registration.

status: Optional[Literal["Ready", "Failed", "Unknown", 3 more]]

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:

"Ready"

"Failed"

"Unknown"

"Deleted"

"Unhealthy"

"BuildOnly"

status_reason: Optional[str]

The reason for the status of the action.

AgentsDeployments

Create Deployment

agents.deployments.create(stragent_id, DeploymentCreateParams**kwargs) -> DeploymentCreateResponse

POST/agents/{agent_id}/deployments

List Deployments

agents.deployments.list(stragent_id, DeploymentListParams**kwargs) -> DeploymentListResponse

GET/agents/{agent_id}/deployments

Get Deployment

agents.deployments.retrieve(strdeployment_id, DeploymentRetrieveParams**kwargs) -> DeploymentRetrieveResponse

GET/agents/{agent_id}/deployments/{deployment_id}

Delete Deployment

agents.deployments.delete(strdeployment_id, DeploymentDeleteParams**kwargs) -> DeleteResponse

DELETE/agents/{agent_id}/deployments/{deployment_id}

Promote Deployment

agents.deployments.promote(strdeployment_id, DeploymentPromoteParams**kwargs) -> DeploymentPromoteResponse

POST/agents/{agent_id}/deployments/{deployment_id}/promote

Preview RPC

agents.deployments.preview_rpc(strdeployment_id, DeploymentPreviewRpcParams**kwargs) -> AgentRpcResponse

POST/agents/{agent_id}/deployments/{deployment_id}/rpc

ModelsExpand Collapse

class DeploymentCreateResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

List[DeploymentListResponseItem]

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

class DeploymentRetrieveResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

class DeploymentPromoteResponse: …

id: str

The unique identifier of the deployment.

agent_id: str

The agent this deployment belongs to.

docker_image: str

Full Docker image URI.

is_production: bool

Whether this is the production deployment.

status: Literal["Pending", "Ready", "Failed"]

Current deployment status.

One of the following:

"Pending"

"Ready"

"Failed"

acp_url: Optional[str]

ACP URL set when agent registers.

created_at: Optional[datetime]

When the deployment was created.

formatdate-time

expires_at: Optional[datetime]

When marked for cleanup.

formatdate-time

helm_release_name: Optional[str]

Helm release name for cleanup.

promoted_at: Optional[datetime]

When promoted to production.

formatdate-time

registration_metadata: Optional[Dict[str, object]]

Git/build metadata from the agent pod.

sgp_deploy_id: Optional[str]

Correlates to SGP’s agentex_deploys.id.

AgentsSchedules

Create Run Schedule

agents.schedules.create(stragent_id, ScheduleCreateParams**kwargs) -> ScheduleCreateResponse

POST/agents/{agent_id}/schedules

List Run Schedules

agents.schedules.list(stragent_id, ScheduleListParams**kwargs) -> ScheduleListResponse

GET/agents/{agent_id}/schedules

Get Run Schedule

agents.schedules.retrieve(strschedule_id, ScheduleRetrieveParams**kwargs) -> ScheduleRetrieveResponse

GET/agents/{agent_id}/schedules/{schedule_id}

Update Run Schedule

agents.schedules.update(strschedule_id, ScheduleUpdateParams**kwargs) -> ScheduleUpdateResponse

PATCH/agents/{agent_id}/schedules/{schedule_id}

Delete Run Schedule

agents.schedules.delete(strschedule_id, ScheduleDeleteParams**kwargs) -> DeleteResponse

DELETE/agents/{agent_id}/schedules/{schedule_id}

Pause Run Schedule

agents.schedules.pause(strschedule_id, SchedulePauseParams**kwargs) -> SchedulePauseResponse

POST/agents/{agent_id}/schedules/{schedule_id}/pause

Resume Run Schedule

agents.schedules.resume(strschedule_id, ScheduleResumeParams**kwargs) -> ScheduleResumeResponse

POST/agents/{agent_id}/schedules/{schedule_id}/resume

Trigger Run Schedule

agents.schedules.trigger(strschedule_id, ScheduleTriggerParams**kwargs) -> ScheduleTriggerResponse

POST/agents/{agent_id}/schedules/{schedule_id}/trigger

Skip Run Schedule Action

agents.schedules.skip(strschedule_id, ScheduleSkipParams**kwargs) -> ScheduleSkipResponse

POST/agents/{agent_id}/schedules/{schedule_id}/skip

Unskip Run Schedule Action

agents.schedules.unskip(strschedule_id, ScheduleUnskipParams**kwargs) -> ScheduleUnskipResponse

POST/agents/{agent_id}/schedules/{schedule_id}/unskip

Get Run Schedule By Name

agents.schedules.retrieve_by_name(strname, ScheduleRetrieveByNameParams**kwargs) -> ScheduleRetrieveByNameResponse

GET/agents/{agent_id}/schedules/name/{name}

Update Run Schedule By Name

agents.schedules.update_by_name(strpath_name, ScheduleUpdateByNameParams**kwargs) -> ScheduleUpdateByNameResponse

PATCH/agents/{agent_id}/schedules/name/{name}

Delete Run Schedule By Name

agents.schedules.delete_by_name(strname, ScheduleDeleteByNameParams**kwargs) -> DeleteResponse

DELETE/agents/{agent_id}/schedules/name/{name}

Pause Run Schedule By Name

agents.schedules.pause_by_name(strname, SchedulePauseByNameParams**kwargs) -> SchedulePauseByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/pause

Resume Run Schedule By Name

agents.schedules.resume_by_name(strname, ScheduleResumeByNameParams**kwargs) -> ScheduleResumeByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/resume

Trigger Run Schedule By Name

agents.schedules.trigger_by_name(strname, ScheduleTriggerByNameParams**kwargs) -> ScheduleTriggerByNameResponse

POST/agents/{agent_id}/schedules/name/{name}/trigger

ModelsExpand Collapse

class ScheduleCreateResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleListResponse: …

Response model for listing run schedules.

run_schedules: List[RunSchedule]

The list of run schedules.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: RunScheduleInitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[RunScheduleCreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

total: int

The number of run schedules returned.

class ScheduleRetrieveResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUpdateResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class SchedulePauseResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleResumeResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleTriggerResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleSkipResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUnskipResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleRetrieveByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleUpdateByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class SchedulePauseByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleResumeByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time

class ScheduleTriggerByNameResponse: …

Response model describing a scheduled agent run.

id: str

The unique identifier of the run schedule.

agent_id: str

The agent this schedule belongs to.

initial_input: InitialInput

The initial input.

content: str

The initial prompt delivered to the task.

author: Optional[MessageAuthor]

The author attributed to the initial input.

One of the following:

"user"

"agent"

type: Optional[Literal["text"]]

Input content type.

initial_input_method: str

Delivery method, inferred from the agent’s ACP type.

name: str

Human-readable schedule name.

created_at: Optional[datetime]

When the schedule was created.

formatdate-time

creator_principal: Optional[CreatorPrincipal]

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.

account_id: Optional[str]

Account/workspace id of the creator.

principal_type: Optional[str]

e.g. ‘user’ or ‘service_account’.

service_account_id: Optional[str]

Creator service-account id, if a service principal.

user_id: Optional[str]

Creator user id, if a user principal.

cron_expression: Optional[str]

Cron cadence, if cron-based.

description: Optional[str]

Optional description.

end_at: Optional[datetime]

Schedule deactivation time.

formatdate-time

interval_seconds: Optional[int]

Interval cadence in seconds, if interval-based.

last_action_time: Optional[datetime]

When the schedule last fired.

formatdate-time

live_data_available: Optional[bool]

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

next_action_times: Optional[List[datetime]]

Upcoming scheduled fire times.

num_actions_taken: Optional[int]

Number of times the schedule has fired.

paused: Optional[bool]

Whether the schedule is paused.

skipped_action_times: Optional[List[datetime]]

Skipped one-off scheduled fire times.

start_at: Optional[datetime]

Schedule activation time.

formatdate-time

state: Optional[Literal["ACTIVE", "PAUSED"]]

Live schedule state from Temporal.

One of the following:

"ACTIVE"

"PAUSED"

task_metadata: Optional[Dict[str, object]]

Task metadata at fire time.

task_params: Optional[Dict[str, object]]

Task params at fire time.

timezone: Optional[str]

Timezone the cron expression is evaluated in.

updated_at: Optional[datetime]

When the schedule was updated.

formatdate-time