Module types 

Request and response data types for this context.

Structs

Agent

An Agent in a Workspace

AgentError

Present when a conversation run failed

AgentToolFinishedPayload

Payload of an agent_tool_finished SSE event

AgentToolProgressPayload

Payload of an agent_tool_progress SSE event, emitted for each inner tool call the delegated Agent makes.

AgentToolStartedPayload

Payload of an agent_tool_started SSE event. When the Agent delegates to another Agent as a tool, that inner run is reported with the agent_tool_* family — the shape mirrors the subagent events.

AgentsResponse

Response for crate::AgentContext::agents

ChatFinishedPayload

Payload of a chat_finished SSE event, observed once all message events for this round have been sent, shortly before workflow_finished

ChatStartedPayload

Payload of a chat_started SSE event

ChatTitleUpdatedPayload

Payload of a chat_title_updated SSE event — the server auto-generates a short title for the conversation as a UI convenience. Can arrive before or after workflow_finished; not tied to the run’s outcome.

ContextCompressFinishedPayload

Payload of a context_compress_finished SSE event. Unlike other events, the timestamp here is an RFC 3339 string.

ContextCompressStartedPayload

Payload of a context_compress_started SSE event, marking the start of a context-compression pass triggered by a long conversation. Unlike other events, the timestamp here is an RFC 3339 string.

ConversationResponse

Response for crate::AgentContext::conversation, crate::AgentContext::continue_conversation, and the final result of the streamed counterparts

GetAgentsOptions

Options for crate::AgentContext::agents

HumanInteraction

A single interaction requested while an Agent workflow is paused.

Interrupt

Present when a conversation run is interrupted, waiting for crate::AgentContext::continue_conversation

MessagePayload

Payload of a message SSE event — an incremental text chunk. This is the highest-frequency event; concatenate text fragments in arrival order.

NodeToolUseFinishedPayload

Payload of a node_tool_use_finished SSE event — the tool call has ended.

NodeToolUseOutputs

outputs of a NodeToolUseFinishedPayload — only carries fields meant for display

NodeToolUseStartedPayload

Payload of a node_tool_use_started SSE event — an ordinary tool call has started. Match it to its NodeToolUseFinished counterpart by tool_use_id.

PlanChangedPayload

Payload of a plan_changed SSE event — the Agent created or updated its task plan.

QueryMaskedPayload

Payload of a query_masked SSE event — sensitive content in the user query was masked before processing. Display masked_query instead of the original query.

Question

One question the Agent needs you to answer

QuestionOption

One option of a Question

Reference

A source referenced by the answer

SubagentFinishedPayload

Payload of a subagent_finished SSE event

SubagentOutputs

outputs of a SubagentFinishedPayload

SubagentProgressPayload

Payload of a subagent_progress SSE event, emitted every time the subagent calls one of its own tools. Use it to render a live timeline inside the subagent card.

SubagentStartedPayload

Payload of a subagent_started SSE event. When the Agent spawns a subagent to work on a sub-task, the subagent’s lifecycle is reported with this dedicated event family instead of node_tool_use_*.

ThinkingFinishedPayload

Payload of a thinking_finished SSE event — the reasoning phase is over; answer text (Message with message_type == "answer") follows.

ThinkingStartedPayload

Payload of a thinking_started SSE event — the Agent has entered the reasoning phase (analyzing the question, planning tool calls). Between this and ConversationStreamEvent::ThinkingFinished, Message events with message_type == "think" and tool-call events may arrive.

WorkflowFinishedPayload

Payload of a workflow_finished SSE event. status is never interrupted here — an interrupted run doesn’t emit workflow_finished at all; see ConversationStreamEvent::HumanInteractionRequired.

WorkflowOutputs

outputs of a workflow_finished SSE event

WorkflowStartedInputs

inputs of a workflow_started SSE event

WorkflowStartedPayload

Payload of a workflow_started SSE event, observed right after chat_started

Workspace

A Workspace the current account belongs to

WorkspacesResponse

Response for crate::AgentContext::workspaces

Enums

ConversationStatus

Final run status of a conversation

ConversationStreamEvent

One event observed while streaming crate::AgentContext::conversation_streamed or crate::AgentContext::continue_conversation_streamed.

Type Aliases

AnswersByToolCall

Answers keyed by tool_call_id, each value being a map of question text to answer, used as the request body of crate::AgentContext::continue_conversation and crate::AgentContext::continue_conversation_streamed.