Module client_api

Expand description

Client-facing API for Steer applications (TUI, IDE plugins, etc.).

Modules§

BashResult: Result for bash command execution
CompactionRecord
CreateSessionParams
EditResult: Result for edit operations
ExternalResult: Result for external/MCP tools
FileContentResult: Result for file content viewing
FileListResult: Result for file listing operations
GlobResult: Result for glob pattern matching
GrepResult
ImageContent
McpServerInfo: Information about an MCP server
Message
MessageId: Message identifier - unique per message in a conversation.
ModelId: Identifier for a model (provider + model id string).
OpId: Operation identifier - unique per user-initiated operation.
Preferences
ProviderAuthStatus
ProviderId: Identifier for a provider (built-in or custom).
ProviderInfo
QueuedWorkItem
ReplaceResult
RequestId: Approval request identifier - unique per tool approval request.
SearchMatch
SearchResult: Result for grep-like search tools
SessionConfig: Session configuration - immutable once created
SessionPolicyOverrides: User-controlled policy overrides applied on top of a primary agent base policy.
SessionToolConfig
StartAuthResponse
TodoListResult: Result for todo operations
ToolCall
ToolCallId: Tool call identifier - unique per tool call.
WorkspaceStatus: Workspace status for orchestration and UI display.

ApiKeyOrigin
ApprovalDecision
AssistantContent: Content that can be sent by an assistant
AuthMethod
AuthProgress
AuthSource
ClientCommand
ClientEvent
CompactResult
EditingMode
ImageSource
McpConnectionState: State of an MCP server connection
McpServerState
McpTransport: MCP transport configuration
MessageData: A message in the conversation, with role-specific content
NotificationTransport
QueuedWorkKind
ThoughtContent: Different types of thought content from AI models
ToolCallDelta
ToolError
ToolResult: Core enum for all tool results
UserContent: Content that can be sent by a user
WorkspaceConfig: Defines the primary execution environment for a session’s workspace