All Classes and Interfaces

Class	Description
AbortEvent	The abort session event.
AbortEvent.AbortEventData	Data payload for AbortEvent.
AccountGetQuotaResult	Result for the account.getQuota RPC method.
AccountQuotaSnapshot
AgentInfo
AgentInfo	Represents a custom agent available for selection in a session.
AssistantIntentEvent	The assistant.intent session event.
AssistantIntentEvent.AssistantIntentEventData	Data payload for AssistantIntentEvent.
AssistantMessageDeltaEvent	The assistant.message_delta session event.
AssistantMessageDeltaEvent.AssistantMessageDeltaEventData	Data payload for AssistantMessageDeltaEvent.
AssistantMessageEvent	The assistant.message session event.
AssistantMessageEvent.AssistantMessageEventData	Data payload for AssistantMessageEvent.
AssistantMessageToolRequest	A tool invocation request from the assistant
AssistantMessageToolRequestType	Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls.
AssistantReasoningDeltaEvent	The assistant.reasoning_delta session event.
AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData	Data payload for AssistantReasoningDeltaEvent.
AssistantReasoningEvent	The assistant.reasoning session event.
AssistantReasoningEvent.AssistantReasoningEventData	Data payload for AssistantReasoningEvent.
AssistantStreamingDeltaEvent	The assistant.streaming_delta session event.
AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData	Data payload for AssistantStreamingDeltaEvent.
AssistantTurnEndEvent	The assistant.turn_end session event.
AssistantTurnEndEvent.AssistantTurnEndEventData	Data payload for AssistantTurnEndEvent.
AssistantTurnStartEvent	The assistant.turn_start session event.
AssistantTurnStartEvent.AssistantTurnStartEventData	Data payload for AssistantTurnStartEvent.
AssistantUsageCopilotUsage	Per-request cost and usage data from the CAPI copilot_usage response field
AssistantUsageCopilotUsageTokenDetail	Token usage detail for a single billing category
AssistantUsageEvent	The assistant.usage session event.
AssistantUsageEvent.AssistantUsageEventData	Data payload for AssistantUsageEvent.
AssistantUsageQuotaSnapshot
Attachment	Represents a file attachment to include with a message.
AuthInfoType	Authentication type
AutoModeSwitchCompletedEvent	The auto_mode_switch.completed session event.
AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData	Data payload for AutoModeSwitchCompletedEvent.
AutoModeSwitchRequestedEvent	The auto_mode_switch.requested session event.
AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData	Data payload for AutoModeSwitchRequestedEvent.
AzureOptions	Azure OpenAI-specific configuration options.
BlobAttachment	Represents an inline base64-encoded binary attachment (blob) for messages.
CapabilitiesChangedEvent	The capabilities.changed session event.
CapabilitiesChangedEvent.CapabilitiesChangedEventData	Data payload for CapabilitiesChangedEvent.
CapabilitiesChangedUI	UI capability changes
CommandCompletedEvent	The command.completed session event.
CommandCompletedEvent.CommandCompletedEventData	Data payload for CommandCompletedEvent.
CommandContext	Context passed to a CommandHandler when a slash command is executed.
CommandDefinition	Defines a slash command that users can invoke from the CLI TUI.
CommandExecuteEvent	The command.execute session event.
CommandExecuteEvent.CommandExecuteEventData	Data payload for CommandExecuteEvent.
CommandHandler	Functional interface for handling slash-command executions.
CommandQueuedEvent	The command.queued session event.
CommandQueuedEvent.CommandQueuedEventData	Data payload for CommandQueuedEvent.
CommandsChangedCommand
CommandsChangedEvent	The commands.changed session event.
CommandsChangedEvent.CommandsChangedEventData	Data payload for CommandsChangedEvent.
CommandWireDefinition	Wire-format representation of a command definition for RPC serialization.
CompactionCompleteCompactionTokensUsed	Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)
CompactionCompleteCompactionTokensUsedCopilotUsage	Per-request cost and usage data from the CAPI copilot_usage response field
CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail	Token usage detail for a single billing category
ConnectionState	Represents the connection state of a CopilotClient.
CopilotClient	Provides a client for interacting with the Copilot CLI server.
CopilotClientOptions	Configuration options for creating a CopilotClient.
CopilotSession	Represents a single conversation session with the Copilot CLI.
CreateSessionRequest	Internal request object for creating a new session.
CreateSessionResponse	Internal response object from creating a session.
CustomAgentConfig	Configuration for a custom agent in a Copilot session.
CustomAgentsUpdatedAgent
DefaultAgentConfig	Configuration for the default agent (the built-in agent that handles turns when no custom agent is selected).
DeleteSessionResponse	Internal response object from deleting a session.
DiscoveredMcpServer
DiscoveredMcpServerSource	Configuration source
DiscoveredMcpServerType	Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)
ElicitationCompletedAction	The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed)
ElicitationCompletedEvent	The elicitation.completed session event.
ElicitationCompletedEvent.ElicitationCompletedEventData	Data payload for ElicitationCompletedEvent.
ElicitationContext	Context for an elicitation request received from the server or MCP tools.
ElicitationHandler	Functional interface for handling elicitation requests from the server.
ElicitationParams	Parameters for an elicitation request sent from the SDK to the host.
ElicitationRequestedEvent	The elicitation.requested session event.
ElicitationRequestedEvent.ElicitationRequestedEventData	Data payload for ElicitationRequestedEvent.
ElicitationRequestedMode	Elicitation mode; "form" for structured input, "url" for browser-based.
ElicitationRequestedSchema	JSON Schema describing the form fields to present to the user (form mode only)
ElicitationResult	Result returned from an elicitation dialog.
ElicitationResultAction	Action value for an ElicitationResult.
ElicitationSchema	JSON Schema describing the form fields to present for an elicitation dialog.
EventErrorHandler	A handler for errors thrown by event handlers during event dispatch.
EventErrorPolicy	Controls how event dispatch behaves when an event handler throws an exception.
ExitPlanModeCompletedEvent	The exit_plan_mode.completed session event.
ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData	Data payload for ExitPlanModeCompletedEvent.
ExitPlanModeRequestedEvent	The exit_plan_mode.requested session event.
ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData	Data payload for ExitPlanModeRequestedEvent.
Extension
ExtensionsLoadedExtension
ExtensionsLoadedExtensionSource	Discovery source
ExtensionsLoadedExtensionStatus	Current status: running, disabled, failed, or starting
ExtensionSource	Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)
ExtensionStatus	Current status: running, disabled, failed, or starting
ExternalToolCompletedEvent	The external_tool.completed session event.
ExternalToolCompletedEvent.ExternalToolCompletedEventData	Data payload for ExternalToolCompletedEvent.
ExternalToolRequestedEvent	The external_tool.requested session event.
ExternalToolRequestedEvent.ExternalToolRequestedEventData	Data payload for ExternalToolRequestedEvent.
GetAuthStatusResponse	Response from the auth.getStatus RPC call.
GetForegroundSessionResponse	Response from session.getForeground RPC call.
GetLastSessionIdResponse	Internal response object from getting the last session ID.
GetMessagesResponse	Internal response object from getting session messages.
GetModelsResponse	Response from the models.list RPC call.
GetSessionMetadataResponse	Internal response object from getting session metadata by ID.
GetStatusResponse	Response from the status.get RPC call.
HandoffRepository	Repository context for the handed-off session
HandoffSourceType	Origin type of the session being handed off
HistoryCompactContextWindow	Post-compaction context window usage breakdown
HookEndError	Error details when the hook failed
HookEndEvent	The hook.end session event.
HookEndEvent.HookEndEventData	Data payload for HookEndEvent.
HookInvocation	Context for a hook invocation.
HookStartEvent	The hook.start session event.
HookStartEvent.HookStartEventData	Data payload for HookStartEvent.
InfiniteSessionConfig	Configuration for infinite sessions with automatic context compaction and workspace persistence.
InputOptions	Options for the SessionUiApi.input(String, InputOptions) convenience method.
InstructionsSources
InstructionsSourcesLocation	Where this source lives — used for UI grouping
InstructionsSourcesType	Category of instruction source — used for merge logic
JsonRpcError	JSON-RPC 2.0 error structure.
JsonRpcRequest	JSON-RPC 2.0 request structure.
JsonRpcResponse	JSON-RPC 2.0 response structure.
ListSessionsResponse	Internal response object from listing sessions.
McpConfigAddParams	Request parameters for the mcp.config.add RPC method.
McpConfigDisableParams	Request parameters for the mcp.config.disable RPC method.
McpConfigEnableParams	Request parameters for the mcp.config.enable RPC method.
McpConfigListResult	Result for the mcp.config.list RPC method.
McpConfigRemoveParams	Request parameters for the mcp.config.remove RPC method.
McpConfigUpdateParams	Request parameters for the mcp.config.update RPC method.
McpDiscoverParams	Request parameters for the mcp.discover RPC method.
McpDiscoverResult	Result for the mcp.discover RPC method.
McpHttpServerConfig	Configuration for a remote HTTP/SSE MCP (Model Context Protocol) server.
McpOauthCompletedEvent	The mcp.oauth_completed session event.
McpOauthCompletedEvent.McpOauthCompletedEventData	Data payload for McpOauthCompletedEvent.
McpOauthRequiredEvent	The mcp.oauth_required session event.
McpOauthRequiredEvent.McpOauthRequiredEventData	Data payload for McpOauthRequiredEvent.
McpOauthRequiredStaticClientConfig	Static OAuth client configuration, if the server specifies one
McpServer
McpServerConfig	Abstract base class for MCP (Model Context Protocol) server configurations.
McpServersLoadedServer
McpServersLoadedServerStatus	Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
McpServerSource	Configuration source: user, workspace, plugin, or builtin
McpServerStatus	Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
McpServerStatusChangedStatus	New connection status: connected, failed, needs-auth, pending, disabled, or not_configured
McpStdioServerConfig	Configuration for a local/stdio MCP (Model Context Protocol) server.
MessageAttachment	Marker interface for all attachment types that can be included in a message.
MessageOptions	Options for sending a message to a Copilot session.
Model
ModelBilling	Billing information
ModelBilling	Model billing information.
ModelCapabilities	Model capabilities and limits
ModelCapabilities	Model capabilities and limits.
ModelCapabilitiesLimits	Token limits for prompts, outputs, and context window
ModelCapabilitiesLimitsVision	Vision-specific limits
ModelCapabilitiesOverride	Override individual model capabilities resolved by the runtime
ModelCapabilitiesOverride	Per-property overrides for model capabilities, deep-merged over runtime defaults.
ModelCapabilitiesOverride.Limits	Token limit overrides for model capabilities.
ModelCapabilitiesOverride.Supports	Feature flag overrides for model capabilities.
ModelCapabilitiesOverrideLimits	Token limits for prompts, outputs, and context window
ModelCapabilitiesOverrideLimitsVision
ModelCapabilitiesOverrideSupports	Feature flags indicating what the model supports
ModelCapabilitiesSupports	Feature flags indicating what the model supports
ModelInfo	Information about an available model.
ModelLimits	Model limits.
ModelPolicy	Policy state (if applicable)
ModelPolicy	Model policy state.
ModelsListResult	Result for the models.list RPC method.
ModelSupports	Model support flags.
ModelVisionLimits	Model vision-specific limits.
PendingMessagesModifiedEvent	The pending_messages.modified session event.
PendingMessagesModifiedEvent.PendingMessagesModifiedEventData	Data payload for PendingMessagesModifiedEvent.
PermissionCompletedEvent	The permission.completed session event.
PermissionCompletedEvent.PermissionCompletedEventData	Data payload for PermissionCompletedEvent.
PermissionCompletedKind	The outcome of the permission request
PermissionCompletedResult	The result of the permission request
PermissionHandler	Functional interface for handling permission requests from the AI assistant.
PermissionInvocation	Context information for a permission request invocation.
PermissionRequest	Represents a permission request from the AI assistant.
PermissionRequestedEvent	The permission.requested session event.
PermissionRequestedEvent.PermissionRequestedEventData	Data payload for PermissionRequestedEvent.
PermissionRequestResult	Result of a permission request decision.
PermissionRequestResultKind	Describes the outcome kind of a permission request result.
PingParams	Request parameters for the ping RPC method.
PingResponse	Response from a ping request to the Copilot CLI server.
PingResult	Result for the ping RPC method.
PlanChangedOperation	The type of operation performed on the plan file
Plugin
PostToolUseHandler	Handler for post-tool-use hooks.
PostToolUseHookInput	Input for a post-tool-use hook.
PostToolUseHookOutput	Output for a post-tool-use hook.
PreToolUseHandler	Handler for pre-tool-use hooks.
PreToolUseHookInput	Input for a pre-tool-use hook.
PreToolUseHookOutput	Output for a pre-tool-use hook.
ProviderConfig	Configuration for a custom API provider (BYOK - Bring Your Own Key).
ResumeSessionConfig	Configuration for resuming an existing Copilot session.
ResumeSessionRequest	Internal request object for resuming an existing session.
ResumeSessionResponse	Internal response object from resuming a session.
RpcCaller	Interface for invoking JSON-RPC methods with typed responses.
SamplingCompletedEvent	The sampling.completed session event.
SamplingCompletedEvent.SamplingCompletedEventData	Data payload for SamplingCompletedEvent.
SamplingRequestedEvent	The sampling.requested session event.
SamplingRequestedEvent.SamplingRequestedEventData	Data payload for SamplingRequestedEvent.
SdkProtocolVersion	Provides the SDK protocol version.
SectionOverride	Override operation for a single system prompt section in SystemMessageMode#CUSTOMIZE mode.
SectionOverrideAction	Specifies the operation to perform on a system prompt section in SystemMessageMode#CUSTOMIZE mode.
SendMessageRequest	Internal request object for sending a message to a session.
SendMessageResponse	Internal response object from sending a message.
ServerAccountApi	API methods for the account namespace.
ServerMcpApi	API methods for the mcp namespace.
ServerMcpConfigApi	API methods for the mcp.config namespace.
ServerModelsApi	API methods for the models namespace.
ServerRpc	Typed client for server-level RPC methods.
ServerSessionFsApi	API methods for the sessionFs namespace.
ServerSessionsApi	API methods for the sessions namespace.
ServerSkill
ServerSkillsApi	API methods for the skills namespace.
ServerSkillsConfigApi	API methods for the skills.config namespace.
ServerToolsApi	API methods for the tools namespace.
SessionAgentApi	API methods for the agent namespace.
SessionAgentDeselectParams	Request parameters for the session.agent.deselect RPC method.
SessionAgentDeselectResult	Result for the session.agent.deselect RPC method.
SessionAgentGetCurrentParams	Request parameters for the session.agent.getCurrent RPC method.
SessionAgentGetCurrentResult	Result for the session.agent.getCurrent RPC method.
SessionAgentListParams	Request parameters for the session.agent.list RPC method.
SessionAgentListResult	Result for the session.agent.list RPC method.
SessionAgentReloadParams	Request parameters for the session.agent.reload RPC method.
SessionAgentReloadResult	Result for the session.agent.reload RPC method.
SessionAgentSelectParams	Request parameters for the session.agent.select RPC method.
SessionAgentSelectResult	Result for the session.agent.select RPC method.
SessionAuthApi	API methods for the auth namespace.
SessionAuthGetStatusParams	Request parameters for the session.auth.getStatus RPC method.
SessionAuthGetStatusResult	Result for the session.auth.getStatus RPC method.
SessionBackgroundTasksChangedEvent	The session.background_tasks_changed session event.
SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData	Data payload for SessionBackgroundTasksChangedEvent.
SessionCapabilities	Represents the capabilities reported by the host for a session.
SessionCommandsApi	API methods for the commands namespace.
SessionCommandsHandlePendingCommandParams	Request parameters for the session.commands.handlePendingCommand RPC method.
SessionCommandsHandlePendingCommandResult	Result for the session.commands.handlePendingCommand RPC method.
SessionCompactionCompleteEvent	The session.compaction_complete session event.
SessionCompactionCompleteEvent.SessionCompactionCompleteEventData	Data payload for SessionCompactionCompleteEvent.
SessionCompactionStartEvent	The session.compaction_start session event.
SessionCompactionStartEvent.SessionCompactionStartEventData	Data payload for SessionCompactionStartEvent.
SessionConfig	Configuration for creating a new Copilot session.
SessionContext	Working directory context for a session.
SessionContextChangedEvent	The session.context_changed session event.
SessionContextChangedEvent.SessionContextChangedEventData	Data payload for SessionContextChangedEvent.
SessionCustomAgentsUpdatedEvent	The session.custom_agents_updated session event.
SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData	Data payload for SessionCustomAgentsUpdatedEvent.
SessionEndHandler	Handler for session-end hooks.
SessionEndHookInput	Input for a session-end hook.
SessionEndHookOutput	Output for a session-end hook.
SessionErrorEvent	The session.error session event.
SessionErrorEvent.SessionErrorEventData	Data payload for SessionErrorEvent.
SessionEvent	Base class for all generated session events.
SessionExtensionsApi	API methods for the extensions namespace.
SessionExtensionsDisableParams	Request parameters for the session.extensions.disable RPC method.
SessionExtensionsDisableResult	Result for the session.extensions.disable RPC method.
SessionExtensionsEnableParams	Request parameters for the session.extensions.enable RPC method.
SessionExtensionsEnableResult	Result for the session.extensions.enable RPC method.
SessionExtensionsListParams	Request parameters for the session.extensions.list RPC method.
SessionExtensionsListResult	Result for the session.extensions.list RPC method.
SessionExtensionsLoadedEvent	The session.extensions_loaded session event.
SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData	Data payload for SessionExtensionsLoadedEvent.
SessionExtensionsReloadParams	Request parameters for the session.extensions.reload RPC method.
SessionExtensionsReloadResult	Result for the session.extensions.reload RPC method.
SessionFleetApi	API methods for the fleet namespace.
SessionFleetStartParams	Request parameters for the session.fleet.start RPC method.
SessionFleetStartResult	Result for the session.fleet.start RPC method.
SessionFsAppendFileParams	Request parameters for the sessionFs.appendFile RPC method.
SessionFsError	Describes a filesystem error.
SessionFsErrorCode	Error classification
SessionFsExistsParams	Request parameters for the sessionFs.exists RPC method.
SessionFsExistsResult	Result for the sessionFs.exists RPC method.
SessionFsMkdirParams	Request parameters for the sessionFs.mkdir RPC method.
SessionFsReaddirParams	Request parameters for the sessionFs.readdir RPC method.
SessionFsReaddirResult	Result for the sessionFs.readdir RPC method.
SessionFsReaddirWithTypesEntry
SessionFsReaddirWithTypesEntryType	Entry type
SessionFsReaddirWithTypesParams	Request parameters for the sessionFs.readdirWithTypes RPC method.
SessionFsReaddirWithTypesResult	Result for the sessionFs.readdirWithTypes RPC method.
SessionFsReadFileParams	Request parameters for the sessionFs.readFile RPC method.
SessionFsReadFileResult	Result for the sessionFs.readFile RPC method.
SessionFsRenameParams	Request parameters for the sessionFs.rename RPC method.
SessionFsRmParams	Request parameters for the sessionFs.rm RPC method.
SessionFsSetProviderConventions	Path conventions used by this filesystem
SessionFsSetProviderParams	Request parameters for the sessionFs.setProvider RPC method.
SessionFsSetProviderResult	Result for the sessionFs.setProvider RPC method.
SessionFsStatParams	Request parameters for the sessionFs.stat RPC method.
SessionFsStatResult	Result for the sessionFs.stat RPC method.
SessionFsWriteFileParams	Request parameters for the sessionFs.writeFile RPC method.
SessionHandoffEvent	The session.handoff session event.
SessionHandoffEvent.SessionHandoffEventData	Data payload for SessionHandoffEvent.
SessionHistoryApi	API methods for the history namespace.
SessionHistoryCompactParams	Request parameters for the session.history.compact RPC method.
SessionHistoryCompactResult	Result for the session.history.compact RPC method.
SessionHistoryTruncateParams	Request parameters for the session.history.truncate RPC method.
SessionHistoryTruncateResult	Result for the session.history.truncate RPC method.
SessionHooks	Hook handlers configuration for a session.
SessionIdleEvent	The session.idle session event.
SessionIdleEvent.SessionIdleEventData	Data payload for SessionIdleEvent.
SessionInfoEvent	The session.info session event.
SessionInfoEvent.SessionInfoEventData	Data payload for SessionInfoEvent.
SessionInstructionsApi	API methods for the instructions namespace.
SessionInstructionsGetSourcesParams	Request parameters for the session.instructions.getSources RPC method.
SessionInstructionsGetSourcesResult	Result for the session.instructions.getSources RPC method.
SessionLifecycleEvent	Session lifecycle event notification.
SessionLifecycleEventMetadata	Metadata for session lifecycle events.
SessionLifecycleEventTypes	Types of session lifecycle events.
SessionLifecycleHandler	Handler for session lifecycle events.
SessionListFilter	Filter options for listing sessions.
SessionLogLevel	Log severity level.
SessionLogParams	Request parameters for the session.log RPC method.
SessionLogResult	Result for the session.log RPC method.
SessionMcpApi	API methods for the mcp namespace.
SessionMcpDisableParams	Request parameters for the session.mcp.disable RPC method.
SessionMcpDisableResult	Result for the session.mcp.disable RPC method.
SessionMcpEnableParams	Request parameters for the session.mcp.enable RPC method.
SessionMcpEnableResult	Result for the session.mcp.enable RPC method.
SessionMcpListParams	Request parameters for the session.mcp.list RPC method.
SessionMcpListResult	Result for the session.mcp.list RPC method.
SessionMcpOauthApi	API methods for the mcp.oauth namespace.
SessionMcpOauthLoginParams	Request parameters for the session.mcp.oauth.login RPC method.
SessionMcpOauthLoginResult	Result for the session.mcp.oauth.login RPC method.
SessionMcpReloadParams	Request parameters for the session.mcp.reload RPC method.
SessionMcpReloadResult	Result for the session.mcp.reload RPC method.
SessionMcpServersLoadedEvent	The session.mcp_servers_loaded session event.
SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData	Data payload for SessionMcpServersLoadedEvent.
SessionMcpServerStatusChangedEvent	The session.mcp_server_status_changed session event.
SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData	Data payload for SessionMcpServerStatusChangedEvent.
SessionMetadata	Metadata about an existing Copilot session.
SessionMode	The agent mode.
SessionModeApi	API methods for the mode namespace.
SessionModeChangedEvent	The session.mode_changed session event.
SessionModeChangedEvent.SessionModeChangedEventData	Data payload for SessionModeChangedEvent.
SessionModeGetParams	Request parameters for the session.mode.get RPC method.
SessionModeGetResult	Result for the session.mode.get RPC method.
SessionModeGetResult.SessionModeGetResultMode	The current agent mode.
SessionModelApi	API methods for the model namespace.
SessionModelChangeEvent	The session.model_change session event.
SessionModelChangeEvent.SessionModelChangeEventData	Data payload for SessionModelChangeEvent.
SessionModelGetCurrentParams	Request parameters for the session.model.getCurrent RPC method.
SessionModelGetCurrentResult	Result for the session.model.getCurrent RPC method.
SessionModelSwitchToParams	Request parameters for the session.model.switchTo RPC method.
SessionModelSwitchToResult	Result for the session.model.switchTo RPC method.
SessionModeSetParams	Request parameters for the session.mode.set RPC method.
SessionModeSetResult	Result for the session.mode.set RPC method.
SessionModeSetResult.SessionModeSetResultMode	The agent mode after switching.
SessionNameApi	API methods for the name namespace.
SessionNameGetParams	Request parameters for the session.name.get RPC method.
SessionNameGetResult	Result for the session.name.get RPC method.
SessionNameSetParams	Request parameters for the session.name.set RPC method.
SessionPermissionsApi	API methods for the permissions namespace.
SessionPermissionsHandlePendingPermissionRequestParams	Request parameters for the session.permissions.handlePendingPermissionRequest RPC method.
SessionPermissionsHandlePendingPermissionRequestResult	Result for the session.permissions.handlePendingPermissionRequest RPC method.
SessionPermissionsResetSessionApprovalsParams	Request parameters for the session.permissions.resetSessionApprovals RPC method.
SessionPermissionsResetSessionApprovalsResult	Result for the session.permissions.resetSessionApprovals RPC method.
SessionPermissionsSetApproveAllParams	Request parameters for the session.permissions.setApproveAll RPC method.
SessionPermissionsSetApproveAllResult	Result for the session.permissions.setApproveAll RPC method.
SessionPlanApi	API methods for the plan namespace.
SessionPlanChangedEvent	The session.plan_changed session event.
SessionPlanChangedEvent.SessionPlanChangedEventData	Data payload for SessionPlanChangedEvent.
SessionPlanDeleteParams	Request parameters for the session.plan.delete RPC method.
SessionPlanDeleteResult	Result for the session.plan.delete RPC method.
SessionPlanReadParams	Request parameters for the session.plan.read RPC method.
SessionPlanReadResult	Result for the session.plan.read RPC method.
SessionPlanUpdateParams	Request parameters for the session.plan.update RPC method.
SessionPlanUpdateResult	Result for the session.plan.update RPC method.
SessionPluginsApi	API methods for the plugins namespace.
SessionPluginsListParams	Request parameters for the session.plugins.list RPC method.
SessionPluginsListResult	Result for the session.plugins.list RPC method.
SessionRemoteSteerableChangedEvent	The session.remote_steerable_changed session event.
SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData	Data payload for SessionRemoteSteerableChangedEvent.
SessionResumeEvent	The session.resume session event.
SessionResumeEvent.SessionResumeEventData	Data payload for SessionResumeEvent.
SessionRpc	Typed client for session-scoped RPC methods.
SessionsForkParams	Request parameters for the sessions.fork RPC method.
SessionsForkResult	Result for the sessions.fork RPC method.
SessionShellApi	API methods for the shell namespace.
SessionShellExecParams	Request parameters for the session.shell.exec RPC method.
SessionShellExecResult	Result for the session.shell.exec RPC method.
SessionShellKillParams	Request parameters for the session.shell.kill RPC method.
SessionShellKillResult	Result for the session.shell.kill RPC method.
SessionShutdownEvent	The session.shutdown session event.
SessionShutdownEvent.SessionShutdownEventData	Data payload for SessionShutdownEvent.
SessionSkillsApi	API methods for the skills namespace.
SessionSkillsDisableParams	Request parameters for the session.skills.disable RPC method.
SessionSkillsDisableResult	Result for the session.skills.disable RPC method.
SessionSkillsEnableParams	Request parameters for the session.skills.enable RPC method.
SessionSkillsEnableResult	Result for the session.skills.enable RPC method.
SessionSkillsListParams	Request parameters for the session.skills.list RPC method.
SessionSkillsListResult	Result for the session.skills.list RPC method.
SessionSkillsLoadedEvent	The session.skills_loaded session event.
SessionSkillsLoadedEvent.SessionSkillsLoadedEventData	Data payload for SessionSkillsLoadedEvent.
SessionSkillsReloadParams	Request parameters for the session.skills.reload RPC method.
SessionSkillsReloadResult	Result for the session.skills.reload RPC method.
SessionSnapshotRewindEvent	The session.snapshot_rewind session event.
SessionSnapshotRewindEvent.SessionSnapshotRewindEventData	Data payload for SessionSnapshotRewindEvent.
SessionStartEvent	The session.start session event.
SessionStartEvent.SessionStartEventData	Data payload for SessionStartEvent.
SessionStartHandler	Handler for session-start hooks.
SessionStartHookInput	Input for a session-start hook.
SessionStartHookOutput	Output for a session-start hook.
SessionTaskCompleteEvent	The session.task_complete session event.
SessionTaskCompleteEvent.SessionTaskCompleteEventData	Data payload for SessionTaskCompleteEvent.
SessionTitleChangedEvent	The session.title_changed session event.
SessionTitleChangedEvent.SessionTitleChangedEventData	Data payload for SessionTitleChangedEvent.
SessionToolsApi	API methods for the tools namespace.
SessionToolsHandlePendingToolCallParams	Request parameters for the session.tools.handlePendingToolCall RPC method.
SessionToolsHandlePendingToolCallResult	Result for the session.tools.handlePendingToolCall RPC method.
SessionToolsUpdatedEvent	The session.tools_updated session event.
SessionToolsUpdatedEvent.SessionToolsUpdatedEventData	Data payload for SessionToolsUpdatedEvent.
SessionTruncationEvent	The session.truncation session event.
SessionTruncationEvent.SessionTruncationEventData	Data payload for SessionTruncationEvent.
SessionUiApi	API methods for the ui namespace.
SessionUiApi	Provides UI methods for eliciting information from the user during a session.
SessionUiCapabilities	UI-specific capability flags for a session.
SessionUiElicitationParams	Request parameters for the session.ui.elicitation RPC method.
SessionUiElicitationResult	The elicitation response (accept with form values, decline, or cancel)
SessionUiHandlePendingElicitationParams	Request parameters for the session.ui.handlePendingElicitation RPC method.
SessionUiHandlePendingElicitationResult	Result for the session.ui.handlePendingElicitation RPC method.
SessionUsageApi	API methods for the usage namespace.
SessionUsageGetMetricsParams	Request parameters for the session.usage.getMetrics RPC method.
SessionUsageGetMetricsResult	Result for the session.usage.getMetrics RPC method.
SessionUsageInfoEvent	The session.usage_info session event.
SessionUsageInfoEvent.SessionUsageInfoEventData	Data payload for SessionUsageInfoEvent.
SessionWarningEvent	The session.warning session event.
SessionWarningEvent.SessionWarningEventData	Data payload for SessionWarningEvent.
SessionWorkspaceApi	API methods for the workspace namespace.
SessionWorkspaceCreateFileParams	Request parameters for the session.workspace.createFile RPC method.
SessionWorkspaceCreateFileResult	Result for the session.workspace.createFile RPC method.
SessionWorkspaceFileChangedEvent	The session.workspace_file_changed session event.
SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData	Data payload for SessionWorkspaceFileChangedEvent.
SessionWorkspaceListFilesParams	Request parameters for the session.workspace.listFiles RPC method.
SessionWorkspaceListFilesResult	Result for the session.workspace.listFiles RPC method.
SessionWorkspaceReadFileParams	Request parameters for the session.workspace.readFile RPC method.
SessionWorkspaceReadFileResult	Result for the session.workspace.readFile RPC method.
SessionWorkspacesApi	API methods for the workspaces namespace.
SessionWorkspacesCreateFileParams	Request parameters for the session.workspaces.createFile RPC method.
SessionWorkspacesGetWorkspaceParams	Request parameters for the session.workspaces.getWorkspace RPC method.
SessionWorkspacesGetWorkspaceResult	Result for the session.workspaces.getWorkspace RPC method.
SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
SessionWorkspacesListFilesParams	Request parameters for the session.workspaces.listFiles RPC method.
SessionWorkspacesListFilesResult	Result for the session.workspaces.listFiles RPC method.
SessionWorkspacesReadFileParams	Request parameters for the session.workspaces.readFile RPC method.
SessionWorkspacesReadFileResult	Result for the session.workspaces.readFile RPC method.
SetForegroundSessionResponse	Response from session.setForeground RPC call.
ShellKillSignal	Signal to send (default: SIGTERM)
ShutdownCodeChanges	Aggregate code change metrics for the session
ShutdownModelMetric
ShutdownModelMetricRequests	Request count and cost metrics
ShutdownModelMetricUsage	Token usage breakdown
ShutdownType	Whether the session ended normally ("routine") or due to a crash/fatal error ("error")
Skill
SkillInvokedEvent	The skill.invoked session event.
SkillInvokedEvent.SkillInvokedEventData	Data payload for SkillInvokedEvent.
SkillsConfigSetDisabledSkillsParams	Request parameters for the skills.config.setDisabledSkills RPC method.
SkillsDiscoverParams	Request parameters for the skills.discover RPC method.
SkillsDiscoverResult	Result for the skills.discover RPC method.
SkillsLoadedSkill
SubagentCompletedEvent	The subagent.completed session event.
SubagentCompletedEvent.SubagentCompletedEventData	Data payload for SubagentCompletedEvent.
SubagentDeselectedEvent	The subagent.deselected session event.
SubagentDeselectedEvent.SubagentDeselectedEventData	Data payload for SubagentDeselectedEvent.
SubagentFailedEvent	The subagent.failed session event.
SubagentFailedEvent.SubagentFailedEventData	Data payload for SubagentFailedEvent.
SubagentSelectedEvent	The subagent.selected session event.
SubagentSelectedEvent.SubagentSelectedEventData	Data payload for SubagentSelectedEvent.
SubagentStartedEvent	The subagent.started session event.
SubagentStartedEvent.SubagentStartedEventData	Data payload for SubagentStartedEvent.
SystemMessageConfig	Configuration for customizing the system message.
SystemMessageEvent	The system.message session event.
SystemMessageEvent.SystemMessageEventData	Data payload for SystemMessageEvent.
SystemMessageMetadata	Metadata about the prompt template and its construction
SystemMessageMode	Specifies how the system message should be applied to a session.
SystemMessageRole	Message role: "system" for system prompts, "developer" for developer-injected instructions
SystemNotificationEvent	The system.notification session event.
SystemNotificationEvent.SystemNotificationEventData	Data payload for SystemNotificationEvent.
SystemPromptSections	Well-known system prompt section identifiers for use with SystemMessageMode#CUSTOMIZE mode.
TelemetryConfig	OpenTelemetry configuration for the Copilot CLI server.
Tool
ToolBinaryResult	Binary result from a tool execution.
ToolDefinition	Defines a tool that can be invoked by the AI assistant.
ToolExecutionCompleteError	Error details when the tool execution failed
ToolExecutionCompleteEvent	The tool.execution_complete session event.
ToolExecutionCompleteEvent.ToolExecutionCompleteEventData	Data payload for ToolExecutionCompleteEvent.
ToolExecutionCompleteResult	Tool execution result on success
ToolExecutionPartialResultEvent	The tool.execution_partial_result session event.
ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData	Data payload for ToolExecutionPartialResultEvent.
ToolExecutionProgressEvent	The tool.execution_progress session event.
ToolExecutionProgressEvent.ToolExecutionProgressEventData	Data payload for ToolExecutionProgressEvent.
ToolExecutionStartEvent	The tool.execution_start session event.
ToolExecutionStartEvent.ToolExecutionStartEventData	Data payload for ToolExecutionStartEvent.
ToolHandler	Functional interface for handling tool invocations from the AI assistant.
ToolInvocation	Represents a tool invocation request from the AI assistant.
ToolResultObject	Result object returned from a tool execution.
ToolsListParams	Request parameters for the tools.list RPC method.
ToolsListResult	Result for the tools.list RPC method.
ToolUserRequestedEvent	The tool.user_requested session event.
ToolUserRequestedEvent.ToolUserRequestedEventData	Data payload for ToolUserRequestedEvent.
UIElicitationResponse	The elicitation response (accept with form values, decline, or cancel)
UIElicitationResponseAction	The user's response: accept (submitted), decline (rejected), or cancel (dismissed)
UIElicitationSchema	JSON Schema describing the form fields to present to the user
UnknownSessionEvent	Fallback for event types not yet known to this SDK version.
UsageMetricsCodeChanges	Aggregated code change metrics
UsageMetricsModelMetric
UsageMetricsModelMetricRequests	Request count and cost metrics for this model
UsageMetricsModelMetricUsage	Token usage metrics for this model
UserInputCompletedEvent	The user_input.completed session event.
UserInputCompletedEvent.UserInputCompletedEventData	Data payload for UserInputCompletedEvent.
UserInputHandler	Handler for user input requests from the agent.
UserInputInvocation	Context for a user input request invocation.
UserInputRequest	Request for user input from the agent.
UserInputRequestedEvent	The user_input.requested session event.
UserInputRequestedEvent.UserInputRequestedEventData	Data payload for UserInputRequestedEvent.
UserInputResponse	Response to a user input request.
UserMessageAgentMode	The agent mode that was active when this message was sent
UserMessageEvent	The user.message session event.
UserMessageEvent.UserMessageEventData	Data payload for UserMessageEvent.
UserPromptSubmittedHandler	Handler for user-prompt-submitted hooks.
UserPromptSubmittedHookInput	Input for a user-prompt-submitted hook.
UserPromptSubmittedHookOutput	Output for a user-prompt-submitted hook.
WorkingDirectoryContext	Working directory and git context at session start
WorkingDirectoryContextHostType	Hosting platform type of the repository (github or ado)
WorkspaceFileChangedOperation	Whether the file was newly created or updated