API Reference Copilot SDK v#2.3.0
Copy MarkdownModules
Elixir SDK for the GitHub Copilot CLI.
Main client for interacting with the Copilot CLI.
Helper for defining tools to expose to the Copilot CLI.
GenServer-based JSON-RPC 2.0 client using Port for stdio communication.
SDK protocol version constant.
Represents a single conversation session with the Copilot CLI.
Type definitions for the Copilot SDK.
A single action exposed by a canvas.
Context passed to a canvas action handler.
Declarative metadata for a canvas provided by the SDK.
Canvas-related capabilities reported by the host.
Host context supplied to canvas callbacks.
Lifecycle context for a canvas instance.
Context passed to a canvas open handler.
Response returned by a canvas open handler.
Options for creating a cloud session.
Repository metadata associated with a cloud session.
Context for a slash-command invocation.
Definition of a slash command registered with the session.
Request to invoke a command.
Request to list available commands.
Options for creating a CopilotClient.
Configuration for a custom agent.
Context for an elicitation request from the server.
Result returned from an elicitation handler.
Request to exit plan mode.
Response to an exit plan mode request.
Response from auth.getStatus.
Response from status.get.
Configuration for infinite sessions with automatic context compaction.
Configuration for a local/stdio MCP server.
Configuration for a remote MCP server (HTTP or SSE).
Options for sending a message to a session.
Model billing information.
Token prices for model billing.
Model capabilities and limits.
Information about an available model.
Model limits.
Price category for the model picker.
Model policy state.
Model support flags.
Vision-specific limits.
Permission request from the server.
Result of a permission decision.
Response from ping.
Configuration for a custom API provider (BYOK).
Request to enable remote mode.
Result of enabling remote mode.
Mode for remote sessions.
Configuration for resuming an existing session.
Override operation for a single system prompt section.
Configuration for creating a session.
Configuration for a custom session filesystem provider.
File metadata returned by session filesystem operations.
Behaviour for session filesystem providers.
Configuration for session hooks.
Session lifecycle event notification.
Metadata about a session.
Diagnostics from loading skills.
Information about a slash command.
Input specification for a slash command.
Completion type for slash command input.
Kind of a slash command.
Append mode: SDK foundation plus optional appended content.
Customize mode: override individual sections of the system prompt.
Replace mode: caller provides entire system message.
Definition of a tool exposed to the Copilot CLI.
Binary result from a tool invocation.
Context passed to a tool handler when invoked.
Structured result of a tool invocation.
OpenTelemetry-compatible trace context for RPC payloads.
Request for user input from the agent (enables ask_user tool).
Response to a user input request.