All Classes and Interfaces
Class
Description
Event: abort
Base class for all session events in the Copilot SDK.
Event: assistant.intent
Event: assistant.message_delta
Event representing a complete message from the assistant.
Contains the assistant message content and metadata.
Represents a request from the assistant to invoke a tool.
Event: assistant.reasoning_delta
Event: assistant.reasoning
Event: assistant.turn_end
Event: assistant.turn_start
Event: assistant.usage
Represents a file attachment to include with a message.
Azure OpenAI-specific configuration options.
Represents the connection state of a
CopilotClient.Provides a client for interacting with the Copilot CLI server.
Configuration options for creating a
CopilotClient.Represents a single conversation session with the Copilot CLI.
Internal request object for creating a new session.
Configuration for a custom agent in a Copilot session.
Internal response object from deleting a session.
Response from the auth.getStatus RPC call.
Response from the models.list RPC call.
Response from the status.get RPC call.
Event: hook.end
Event: hook.start
Configuration for infinite sessions with automatic context compaction and
workspace persistence.
JSON-RPC 2.0 error structure.
JSON-RPC 2.0 request structure.
JSON-RPC 2.0 response structure.
Internal response object from listing sessions.
Options for sending a message to a Copilot session.
Model billing information.
Model capabilities and limits.
Information about an available model.
Model limits.
Model policy state.
Model support flags.
Model vision-specific limits.
Event: pending_messages.modified
Functional interface for handling permission requests from the AI assistant.
Context information for a permission request invocation.
Represents a permission request from the AI assistant.
Result of a permission request decision.
Response from a ping request to the Copilot CLI server.
Configuration for a custom API provider (BYOK - Bring Your Own Key).
Configuration for resuming an existing Copilot session.
Internal request object for resuming an existing session.
Provides the SDK protocol version.
Internal request object for sending a message to a session.
Internal response object from sending a message.
Event: session.compaction_complete
Event: session.compaction_start
Configuration for creating a new Copilot session.
Event: session.error
Parser for session events that handles polymorphic deserialization.
Event: session.handoff
Event: session.idle
Event: session.info
Metadata about an existing Copilot session.
Event: session.model_change
Event: session.resume
Event: session.start
Event: session.truncation
Event: session.usage_info
Event: subagent.completed
Event: subagent.failed
Event: subagent.selected
Event: subagent.started
Configuration for customizing the system message.
Event: system.message
Specifies how the system message should be applied to a session.
Binary result from a tool execution.
Low-level tool definition for JSON-RPC communication.
Defines a tool that can be invoked by the AI assistant.
Event: tool.execution_complete
Event: tool.execution_partial_result
Event fired when a tool execution reports progress.
Event: tool.execution_start
Functional interface for handling tool invocations from the AI assistant.
Represents a tool invocation request from the AI assistant.
Result object returned from a tool execution.
Event: tool.user_requested
Event: user.message