Expand description
Agent sessions (ACP) methods + supporting types.
Mirrors the durable session surface in packages/core/src/session-api.ts.
Agent types are resolved dynamically from projected package manifests; the
client has no hardcoded agent registry.
The sidecar owns ACP JSON-RPC, adapter restoration, and SQLite history. This client exposes typed durable operations and exact upstream ACP data types, not a second raw JSON-RPC session API.
Structs§
- Agent
Exit Event - Agent
Message - Agent
Registry Entry - A registry agent entry from
list_agents. Mirrors the TSAgentRegistryEntry. The client is npm-agnostic and parses no manifests:list_agentsis a sidecar ACP RPC that enumerates the projected/opt/agentospackages. The entry is just the agentid;installedis alwaystrue(the package is materialized into the VM at boot). - Available
Commands Update - Available commands are ready or have changed
- Config
Option Update - Session configuration options have been updated.
- Content
Chunk - A streamed item of content
- Current
Mode Update - The current mode of the session has changed
- Durable
Session Event Entry - Ephemeral
Session Event Entry - History
Page - List
Sessions Input - Open
Session Input - Immutable options used to open a durable AgentOS session. Omitted fields are forwarded as omissions so the sidecar remains the single owner of defaults.
- Pending
Permission Request - Permission
Option - An option presented to the user when requesting permission.
- Plan
- An execution plan for accomplishing complex tasks.
- Prompt
Input - Prompt
Result - Read
History Input - Request
Permission Request - Request for user permission to execute a tool call.
- Request
Permission Response - Response to a permission request.
- Session
Capabilities - Session
Config - Session
Config Option - A session configuration option selector and its current state.
- Session
Info - SQLite-backed session metadata. Reading it never starts an ACP adapter.
- Session
Info Update - Update to session metadata. All fields are optional to support partial updates.
- Session
Page - Tool
Call - Represents a tool call that the language model has requested.
- Tool
Call Update - An update to an existing tool call.
- Usage
Update - Context window and cost update for a session.
Enums§
- Agent
Restart Outcome - An unexpected ACP adapter process exit — a crash from the host’s
perspective (any spontaneous exit without
unload_session, including exit code 0). Mirrors the wireAcpAgentExitedEventand the TSAgentExitEvent. - Cancel
Prompt Status - Content
Block - Content blocks represent displayable information in the Agent Client Protocol.
- Durable
Event Kind - Durable
Session Event - Ephemeral
Event Kind - Ephemeral
Session Event - McpServer
Config - Configuration for connecting to an MCP (Model Context Protocol) server.
- Permission
Event Status - Permission
Policy - Permission
Response Status - Permission
Terminal Reason - Request
Permission Outcome - The outcome of a permission request.
- Session
Config Value - Native ACP configuration values are deliberately limited to the protocol’s string and boolean variants.
- Session
State - Session
Stream Entry - Session
Subscription Error - A bounded live session subscription fell behind. Durable updates remain in
SQLite and can be recovered with
read_history; ephemeral deltas cannot be recovered. - Session
Update - Different types of updates that can be sent during session processing.
- Stop
Reason - Reasons why an agent stops processing a prompt turn.
Type Aliases§
- Agent
Exit Stream - Agent
Exit Subscription - Durable
Session Event Stream - Durable
Session Event Subscription - Meta
- Value attached to a given ACP type on the
_metafield.