Expand description
Core types for the Copilot SDK.
Modules§
- session_
lifecycle_ event_ types - Session lifecycle event type constants.
Structs§
- Azure
Options - Azure-specific provider options.
- Client
Options - Options for creating a CopilotClient.
- Custom
Agent Config - Configuration for a custom agent.
- Error
Occurred Hook Input - Input for the error-occurred hook.
- Error
Occurred Hook Output - Output for the error-occurred hook.
- GetAuth
Status Response - Response from auth.getStatus request.
- GetForeground
Session Response - Response from session.getForeground.
- GetStatus
Response - Response from status.get request.
- Infinite
Session Config - Configuration for infinite sessions (automatic context compaction).
- McpLocal
Server Config - Configuration for a local/stdio MCP server.
- McpRemote
Server Config - Configuration for a remote MCP server (HTTP or SSE).
- Message
Options - Options for sending a message.
- Model
Billing - Model billing information.
- Model
Capabilities - Model capabilities - what the model supports.
- Model
Info - Information about an available model.
- Model
Limits - Model limits.
- Model
Policy - Model policy state.
- Model
Supports - What features a model supports.
- Model
Vision Limits - Vision limits for a model.
- Permission
Request - Permission request from the server.
- Permission
Request Result - Result of a permission request (response to CLI).
- Ping
Response - Response from a ping request.
- Post
Tool UseHook Input - Input for the post-tool-use hook.
- Post
Tool UseHook Output - Output for the post-tool-use hook.
- PreTool
UseHook Input - Input for the pre-tool-use hook.
- PreTool
UseHook Output - Output for the pre-tool-use hook.
- Provider
Config - Provider configuration for BYOK (Bring Your Own Key).
- Resume
Session Config - Configuration for resuming an existing session.
- Selection
Attachment - Attachment representing a text selection in a file.
- Selection
Position - Position in a text document (line + character).
- Selection
Range - Range within a text document.
- Session
Config - Configuration for creating a new session.
- Session
EndHook Input - Input for the session-end hook.
- Session
EndHook Output - Output for the session-end hook.
- Session
Hooks - Configuration for session hooks.
- Session
Lifecycle Event - Session lifecycle event notification.
- Session
Lifecycle Event Metadata - Metadata for session lifecycle events.
- Session
Metadata - Metadata about a session.
- Session
Start Hook Input - Input for the session-start hook.
- Session
Start Hook Output - Output for the session-start hook.
- SetForeground
Session Response - Response from session.setForeground.
- Stop
Error - Error collected during client stop.
- System
Message Config - System message configuration.
- Tool
- Tool definition for registration with a session.
- Tool
Binary Result - Binary result from a tool execution.
- Tool
Invocation - Information about a tool invocation from the server.
- Tool
Result Object - Result object returned from tool execution.
- User
Input Invocation - Context for a user input invocation.
- User
Input Request - Request for user input from the server.
- User
Input Response - Response to a user input request.
- User
Message Attachment - Attachment item for user messages.
- User
Prompt Submitted Hook Input - Input for the user-prompt-submitted hook.
- User
Prompt Submitted Hook Output - Output for the user-prompt-submitted hook.
Enums§
- Attachment
Type - Attachment type for user messages.
- Connection
State - Connection state of the client.
- LogLevel
- Log level for the CLI.
- McpServer
Config - MCP server configuration (either local or remote).
- System
Message Mode - System message mode for session configuration.
Constants§
- SDK_
PROTOCOL_ VERSION - SDK protocol version - must match copilot-agent-runtime server.
Type Aliases§
- Error
Occurred Handler - Post
Tool UseHandler - PreTool
UseHandler - Handler types for session hooks.
- Session
EndHandler - Session
Start Handler - Tool
Result - Convenient alias for tool results.
- User
Prompt Submitted Handler