Package com.github.copilot.generated.rpc

package com.github.copilot.generated.rpc

Auto-generated RPC parameter and result types for the GitHub Copilot SDK.

This package contains Java records and classes generated from the Copilot CLI's api.schema.json. These types represent the request parameters and response payloads for all JSON-RPC methods exposed by the CLI.

Key Classes

• RpcCaller - Functional interface for invoking JSON-RPC methods with typed responses.
• ServerRpc - Typed client for server-level RPC methods (session management, model listing, etc.).
• SessionRpc - Typed client for session-scoped RPC methods (send messages, manage tools, etc.). Automatically injects the sessionId into every call.

Related Packages

• com.github.copilot - Core SDK classes
• com.github.copilot.generated - Auto-generated session event types

See Also:

• CopilotClient
• ServerRpc
• SessionRpc

Related Packages

Package	Description
com.github.copilot.generated	Auto-generated session event types for the GitHub Copilot SDK.

Class	Description
AbortReason	Finite reason code describing why the current turn was aborted
AccountAllUsers	Schema for the `AccountAllUsers` type.
AccountGetCurrentAuthResult	Current authentication state
AccountGetQuotaResult	Quota usage snapshots for the resolved user, keyed by quota type.
AccountLoginParams	Credentials to store after successful authentication
AccountLoginResult	Result of a successful login; throws on failure
AccountLogoutParams	User to log out
AccountLogoutResult	Logout result indicating if more users remain
AccountQuotaSnapshot	Schema for the `AccountQuotaSnapshot` type.
AdaptiveThinkingSupport	Resolved Anthropic adaptive-thinking capability for a model.
AgentDiscoveryPath	Schema for the `AgentDiscoveryPath` type.
AgentDiscoveryPathScope	Which tier this directory belongs to
AgentInfo	Schema for the `AgentInfo` type.
AgentInfoSource	Where the agent definition was loaded from
AgentRegistryLiveTargetEntry	Full registry entry for the spawned child.
AgentRegistryLiveTargetEntryAttentionKind	Kind of attention required when status === "attention".
AgentRegistryLiveTargetEntryKind	Process kind tag for the registry entry
AgentRegistryLiveTargetEntryLastTerminalEvent	How the most recent turn ended (clean vs aborted).
AgentRegistryLiveTargetEntryStatus	Coarse lifecycle status of the foreground session
AgentRegistryLogCapture	Per-spawn log-capture outcome; populated from spawnLiveTarget.
AgentRegistryLogCaptureOpenErrorReason	Categorized reason for log-open failure
AgentRegistrySpawnError	`child_process.spawn` itself failed before the child entered the registry.
AgentRegistrySpawnParams	Inputs to spawn a managed-server child via the controller's spawn delegate.
AgentRegistrySpawnPermissionMode	Permission posture for the new session.
AgentRegistrySpawnRegistryTimeout	Spawn succeeded but the child did not publish a matching managed-server entry within the timeout.
AgentRegistrySpawnResult	Outcome of an agentRegistry.spawn call.
AgentRegistrySpawnSpawned	Managed-server child was spawned and registered successfully.
AgentRegistrySpawnValidationError	Synchronous pre-validation rejected the spawn request.
AgentRegistrySpawnValidationErrorField	Which parameter field was invalid.
AgentRegistrySpawnValidationErrorReason	Categorized reason for the rejection.
AgentsDiscoverParams	Optional project paths to include in agent discovery.
AgentsDiscoverResult	Agents discovered across user, project, plugin, and remote sources.
AgentsGetDiscoveryPathsParams	Optional project paths to include when enumerating agent discovery directories.
AgentsGetDiscoveryPathsResult	Canonical locations where custom agents can be created so the runtime will recognize them.
AuthInfoType	Authentication type
CanvasAction	Canvas action that the agent or host can invoke.
CanvasActionInvokeParams	Canvas action invocation parameters sent to the provider.
CanvasCloseParams	Canvas close parameters sent to the provider.
CanvasHostContext	Host context supplied by the runtime.
CanvasHostContextCapabilities	Host capabilities
CanvasOpenParams	Canvas open parameters sent to the provider.
CanvasOpenResult	Canvas open result returned by the provider.
CanvasSessionContext	Session context supplied by the runtime.
CapiSessionOptions	Options scoped to the built-in CAPI (Copilot API) provider.
ConnectedRemoteSessionMetadata	Metadata for a connected remote session.
ConnectedRemoteSessionMetadataKind	Neutral SDK discriminator for the connected remote session kind.
ConnectedRemoteSessionMetadataRepository	Repository associated with the connected remote session.
ConnectParams	Optional connection token presented by the SDK client during the handshake.
ConnectResult	Handshake result reporting the server's protocol version and package version on success.
ContextTier	Context tier for models that support multiple context-window sizes.
CurrentToolMetadata	Lightweight metadata for a currently initialized session tool
DiscoveredCanvas	Canvas available in the current session.
DiscoveredMcpServer	Schema for the `DiscoveredMcpServer` type.
DiscoveredMcpServerType	Server transport type: stdio, http, sse (deprecated), or memory
EventsAgentScope	Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.'
EventsCursorStatus	Cursor status: 'ok' means the cursor was applied successfully; 'expired' means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read started from the beginning of the remaining history.
Extension	Schema for the `Extension` type.
ExtensionSource	Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/)
ExtensionStatus	Current status: running, disabled, failed, or starting
GitHubTelemetryClientInfo	Client environment metadata describing the process that produced a telemetry event.
GitHubTelemetryEvent	A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts.
GitHubTelemetryNotification	Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding for the session.
HistoryCompactContextWindow	Post-compaction context window usage breakdown
InstalledPlugin	Schema for the `InstalledPlugin` type.
InstalledPluginInfo	Information about an installed plugin tracked in global state.
InstructionDiscoveryPath	Schema for the `InstructionDiscoveryPath` type.
InstructionDiscoveryPathKind	Whether the target is a single file or a directory of instruction files
InstructionDiscoveryPathLocation	Which tier this target belongs to
InstructionsDiscoverParams	Optional project paths to include in instruction discovery.
InstructionsDiscoverResult	Instruction sources discovered across user, repository, and plugin sources.
InstructionsGetDiscoveryPathsParams	Optional project paths to include when enumerating instruction discovery targets.
InstructionsGetDiscoveryPathsResult	Canonical files and directories where custom instructions can be created so the runtime will recognize them.
InstructionSource	Schema for the `InstructionSource` type.
InstructionSourceLocation	Where this source lives — used for UI grouping
InstructionSourceType	Category of instruction source — used for merge logic
LlmInferenceHttpRequestChunkRequest	A request body chunk or cancellation signal.
LlmInferenceHttpRequestChunkResult	Acknowledgement.
LlmInferenceHttpRequestStartRequest	The head of an outbound model-layer HTTP request.
LlmInferenceHttpRequestStartResult	Acknowledgement.
LlmInferenceHttpRequestStartTransport	Transport the runtime would otherwise use for this request.
LlmInferenceHttpResponseChunkError	Set to terminate the response with a transport-level failure.
LlmInferenceHttpResponseChunkParams	A response body chunk or terminal error.
LlmInferenceHttpResponseChunkResult	Whether the chunk was accepted.
LlmInferenceHttpResponseStartParams	Response head.
LlmInferenceHttpResponseStartResult	Whether the start frame was accepted.
LlmInferenceSetProviderResult	Indicates whether the calling client was registered as the LLM inference provider.
LocalSessionMetadataValue	Schema for the `LocalSessionMetadataValue` type.
MarketplaceInfo	Registered marketplace summary.
MarketplacePluginInfo	Plugin entry advertised by a marketplace.
MarketplaceRefreshEntry	Schema for the `MarketplaceRefreshEntry` type.
McpAllowedServer	Schema for the `McpAllowedServer` type.
McpAppsDiagnoseCapability	Capability negotiation snapshot
McpAppsDiagnoseServer	What the server returned for this session
McpAppsHostContextDetails	Current host context
McpAppsHostContextDetailsAvailableDisplayMode	Allowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration.
McpAppsHostContextDetailsDisplayMode	Current display mode (SEP-1865)
McpAppsHostContextDetailsPlatform	Platform type for responsive design
McpAppsHostContextDetailsTheme	UI theme preference per SEP-1865
McpAppsResourceContent	Schema for the `McpAppsResourceContent` type.
McpAppsSetHostContextDetails	Host context advertised to MCP App guests
McpAppsSetHostContextDetailsAvailableDisplayMode	Allowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration.
McpAppsSetHostContextDetailsDisplayMode	Current display mode (SEP-1865)
McpAppsSetHostContextDetailsPlatform	Platform type for responsive design
McpAppsSetHostContextDetailsTheme	UI theme preference per SEP-1865
McpConfigAddParams	MCP server name and configuration to add to user configuration.
McpConfigDisableParams	MCP server names to disable for new sessions.
McpConfigEnableParams	MCP server names to enable for new sessions.
McpConfigListResult	User-configured MCP servers, keyed by server name.
McpConfigRemoveParams	MCP server name to remove from user configuration.
McpConfigUpdateParams	MCP server name and replacement configuration to write to user configuration.
McpDiscoverParams	Optional working directory used as context for MCP server discovery.
McpDiscoverResult	MCP servers discovered from user, workspace, plugin, and built-in sources.
McpExecuteSamplingRequest	Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event.
McpExecuteSamplingResult	MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'.
McpFilteredServer	Schema for the `McpFilteredServer` type.
McpHostState	Host-level state, omitted when no MCP host is initialized.
McpOauthLoginGrantType	OAuth grant type override for this login.
McpSamplingExecutionAction	Outcome of the sampling inference.
McpServer	Schema for the `McpServer` type.
McpServerFailureInfo	Recorded MCP server connection failure.
McpServerNeedsAuthInfo	Recorded MCP server pending-auth state.
McpServerSource	Configuration source: user, workspace, plugin, or builtin
McpServerStatus	Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
McpSetEnvValueModeDetails	How environment-variable values supplied to MCP servers are resolved.
McpTools	Schema for the `McpTools` type.
MetadataSnapshotCurrentMode	The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')
MetadataSnapshotRemoteMetadata	Remote-session-specific metadata.
MetadataSnapshotRemoteMetadataRepository	The repository the remote session targets.
MetadataSnapshotRemoteMetadataTaskType	Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation.
Model	Schema for the `Model` type.
ModelBilling	Billing information
ModelBillingTokenPrices	Token-level pricing information for this model
ModelBillingTokenPricesLongContext	Long context tier pricing (available for models with extended context windows)
ModelCapabilities	Model capabilities and limits
ModelCapabilitiesLimits	Token limits for prompts, outputs, and context window
ModelCapabilitiesLimitsVision	Vision-specific limits
ModelCapabilitiesOverride	Optional capability overrides (vision, tool_calls, reasoning, etc.).
ModelCapabilitiesOverrideLimits	Token limits for prompts, outputs, and context window
ModelCapabilitiesOverrideLimitsVision	Vision-specific limits
ModelCapabilitiesOverrideSupports	Feature flags indicating what the model supports
ModelCapabilitiesSupports	Feature flags indicating what the model supports
ModelPickerCategory	Model capability category for grouping in the model picker
ModelPickerPriceCategory	Relative cost tier for token-based billing users
ModelPolicy	Policy state (if applicable)
ModelPolicyState	Current policy state for this model
ModelsListResult	List of Copilot models available to the resolved user, including capabilities and billing metadata.
NamedProviderConfig	A named BYOK provider connection (transport + credentials).
OpenCanvasInstance	Open canvas instance snapshot.
OptionsUpdateAdditionalContentExclusionPolicy	Schema for the `OptionsUpdateAdditionalContentExclusionPolicy` type.
OptionsUpdateAdditionalContentExclusionPolicyRule	Schema for the `OptionsUpdateAdditionalContentExclusionPolicyRule` type.
OptionsUpdateAdditionalContentExclusionPolicyRuleSource	Schema for the `OptionsUpdateAdditionalContentExclusionPolicyRuleSource` type.
OptionsUpdateAdditionalContentExclusionPolicyScope	Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration.
OptionsUpdateContextTier	Context tier for models with tiered pricing.
OptionsUpdateEnvValueMode	How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch).
OptionsUpdateReasoningSummary	Reasoning summary mode for supported model clients.
OptionsUpdateToolFilterPrecedence	Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set.
PendingPermissionRequest	Schema for the `PendingPermissionRequest` type.
PermissionLocationType	Whether the location is a git repo or directory
PermissionPathsConfig	If specified, replaces the session's path-permission policy.
PermissionRule	Schema for the `PermissionRule` type.
PermissionRulesSet	If specified, replaces the session's approved/denied permission rules.
PermissionsConfigureAdditionalContentExclusionPolicy	Schema for the `PermissionsConfigureAdditionalContentExclusionPolicy` type.
PermissionsConfigureAdditionalContentExclusionPolicyRule	Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRule` type.
PermissionsConfigureAdditionalContentExclusionPolicyRuleSource	Schema for the `PermissionsConfigureAdditionalContentExclusionPolicyRuleSource` type.
PermissionsConfigureAdditionalContentExclusionPolicyScope	Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration.
PermissionsModifyRulesScope	Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file.
PermissionsSetAllowAllSource	Optional source for allow-all telemetry.
PermissionsSetApproveAllSource	Optional source for allow-all telemetry.
PermissionUrlsConfig	If specified, replaces the session's URL-permission policy.
PingParams	Optional message to echo back to the caller.
PingResult	Server liveness response, including the echoed message, current server timestamp, and protocol version.
PlanSqlTodoDependency	A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another.
PlanSqlTodosRow	A single todo row read from the session SQL `todos` table.
Plugin	Schema for the `Plugin` type.
PluginsDisableParams	Plugin names (or specs) to disable.
PluginsEnableParams	Plugin names (or specs) to enable.
PluginsInstallParams	Plugin source and optional working directory for relative-path resolution.
PluginsInstallResult	Result of installing a plugin.
PluginsListResult	Plugins installed in user/global state.
PluginsMarketplacesAddParams	Marketplace source to register.
PluginsMarketplacesAddResult	Result of registering a new marketplace.
PluginsMarketplacesBrowseParams	Name of the marketplace whose plugin catalog to fetch.
PluginsMarketplacesBrowseResult	Plugins advertised by the marketplace.
PluginsMarketplacesListResult	All registered marketplaces, including built-in defaults.
PluginsMarketplacesRefreshResult	Result of refreshing one or more marketplace catalogs.
PluginsMarketplacesRemoveParams	Name of the marketplace to remove and an optional force flag.
PluginsMarketplacesRemoveResult	Outcome of the remove attempt, including dependent-plugin info when applicable.
PluginsUninstallParams	Name (or spec) of the plugin to uninstall.
PluginsUpdateAllResult	Result of updating all installed plugins.
PluginsUpdateParams	Name (or spec) of the plugin to update.
PluginsUpdateResult	Result of updating a single plugin.
PluginUpdateAllEntry	Schema for the `PluginUpdateAllEntry` type.
ProviderConfig	Custom model-provider configuration (BYOK).
ProviderConfigAzure	Azure-specific provider options.
ProviderConfigTransport	Provider transport.
ProviderConfigType	Provider type.
ProviderConfigWireApi	Wire API format (openai/azure only).
ProviderEndpointTransport	Transport to be used for provider requests.
ProviderEndpointType	Provider family.
ProviderEndpointWireApi	Wire API to be used, when required for the provider type.
ProviderModelConfig	A BYOK model definition referencing a named provider.
ProviderSessionToken	Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present.
ProviderTokenGetTokenParams	Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`.
ProviderTokenGetTokenResult	A bearer token supplied by the SDK client for a BYOK provider.
QueuePendingItems	Schema for the `QueuePendingItems` type.
QueuePendingItemsKind	Whether this item is a queued user message or a queued slash command / model change
ReasoningSummary	Reasoning summary mode to request for supported model clients
RemoteControlConfig	Configuration for the runtime-managed remote-control singleton.
RemoteControlConfigExistingMcSession	Reattach to an existing MC session without creating a new one.
RemoteSessionMetadataRepository	GitHub repository the remote session belongs to.
RemoteSessionMetadataTaskType	Whether the remote task originated from CCA or CLI `--remote`.
RemoteSessionMetadataValue	Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`).
RemoteSessionMode	Per-session remote mode.
RpcCaller	Interface for invoking JSON-RPC methods with typed responses.
SandboxConfig	Resolved sandbox configuration.
SandboxConfigUserPolicy	User-managed sandbox policy fragment merged into the auto-discovered base policy.
SandboxConfigUserPolicyExperimental	Platform-specific experimental policy fields.
SandboxConfigUserPolicyExperimentalSeatbelt	macOS seatbelt experimental options.
SandboxConfigUserPolicyFilesystem	Filesystem rules to merge into the base policy.
SandboxConfigUserPolicyNetwork	Network rules to merge into the base policy.
SandboxConfigUserPolicySeatbelt	macOS seatbelt-specific options.
ScheduleEntry	Schema for the `ScheduleEntry` type.
SecretsAddFilterValuesParams	Secret values to add to the redaction filter.
SecretsAddFilterValuesResult	Confirmation that the secret values were registered.
SendAgentMode	The UI mode the agent was in when this message was sent.
SendMode	How to deliver the message.
ServerAccountApi	API methods for the account namespace.
ServerAgentRegistryApi	API methods for the agentRegistry namespace.
ServerAgentsApi	API methods for the agents namespace.
ServerInstructionsApi	API methods for the instructions namespace.
ServerLlmInferenceApi	API methods for the llmInference namespace.
ServerMcpApi	API methods for the mcp namespace.
ServerMcpConfigApi	API methods for the mcp.config namespace.
ServerModelsApi	API methods for the models namespace.
ServerPluginsApi	API methods for the plugins namespace.
ServerPluginsMarketplacesApi	API methods for the plugins.marketplaces namespace.
ServerRpc	Typed client for server-level RPC methods.
ServerRuntimeApi	API methods for the runtime namespace.
ServerSecretsApi	API methods for the secrets namespace.
ServerSessionFsApi	API methods for the sessionFs namespace.
ServerSessionsApi	API methods for the sessions namespace.
ServerSkill	Schema for the `ServerSkill` type.
ServerSkillsApi	API methods for the skills namespace.
ServerSkillsConfigApi	API methods for the skills.config namespace.
ServerToolsApi	API methods for the tools namespace.
ServerUserApi	API methods for the user namespace.
ServerUserSettingsApi	API methods for the user.settings namespace.
SessionAbortParams	Parameters for aborting the current turn
SessionAbortResult	Result of aborting the current turn
SessionAgentApi	API methods for the agent namespace.
SessionAgentDeselectParams	Identifies the target session.
SessionAgentGetCurrentParams	Identifies the target session.
SessionAgentGetCurrentResult	The currently selected custom agent, or null when using the default agent.
SessionAgentListParams	Identifies the target session.
SessionAgentListResult	Custom agents available to the session.
SessionAgentReloadParams	Identifies the target session.
SessionAgentReloadResult	Custom agents available to the session after reloading definitions from disk.
SessionAgentSelectParams	Name of the custom agent to select for subsequent turns.
SessionAgentSelectResult	The newly selected custom agent.
SessionCanvasActionApi	API methods for the canvas.action namespace.
SessionCanvasActionInvokeParams	Canvas action invocation parameters.
SessionCanvasActionInvokeResult	Canvas action invocation result.
SessionCanvasApi	API methods for the canvas namespace.
SessionCanvasCloseParams	Canvas close parameters.
SessionCanvasListOpenParams	Identifies the target session.
SessionCanvasListOpenResult	Live open-canvas snapshot.
SessionCanvasListParams	Identifies the target session.
SessionCanvasListResult	Declared canvases available in this session.
SessionCanvasOpenParams	Canvas open parameters.
SessionCanvasOpenResult	Open canvas instance snapshot.
SessionCapability	Session capability enabled for this session
SessionCommandsApi	API methods for the commands namespace.
SessionCommandsEnqueueParams	Slash-prefixed command string to enqueue for FIFO processing.
SessionCommandsEnqueueResult	Indicates whether the command was accepted into the local execution queue.
SessionCommandsExecuteParams	Slash command name and argument string to execute synchronously.
SessionCommandsExecuteResult	Error message produced while executing the command, if any.
SessionCommandsHandlePendingCommandParams	Pending command request ID and an optional error if the client handler failed.
SessionCommandsHandlePendingCommandResult	Indicates whether the pending client-handled command was completed successfully.
SessionCommandsInvokeParams	Slash command name and optional raw input string to invoke.
SessionCommandsListParams	Optional filters controlling which command sources to include in the listing.
SessionCommandsListResult	Slash commands available in the session, after applying any include/exclude filters.
SessionCommandsRespondToQueuedCommandParams	Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).
SessionCommandsRespondToQueuedCommandResult	Indicates whether the queued-command response was matched to a pending request.
SessionCompletionItem	A single host-driven completion.
SessionCompletionsApi	API methods for the completions namespace.
SessionCompletionsGetTriggerCharactersParams	Identifies the target session.
SessionCompletionsGetTriggerCharactersResult	Characters that, when typed in the composer, should trigger a `completions.request`.
SessionCompletionsRequestParams	Request host-driven completions for the current composer input.
SessionCompletionsRequestResult	Host-driven completion items for the current composer input.
SessionContext	Pre-resolved working-directory context for session startup.
SessionContextHostType	Repository host type
SessionEventLogApi	API methods for the eventLog namespace.
SessionEventLogReadParams	Cursor, batch size, and optional long-poll/filter parameters for reading session events.
SessionEventLogReadResult	Batch of session events returned by a read, with cursor and continuation metadata.
SessionEventLogRegisterInterestParams	Event type to register consumer interest for, used by runtime gating logic.
SessionEventLogRegisterInterestResult	Opaque handle representing an event-type interest registration.
SessionEventLogReleaseInterestParams	Opaque handle previously returned by `registerInterest` to release.
SessionEventLogReleaseInterestResult	Indicates whether the operation succeeded.
SessionEventLogTailParams	Identifies the target session.
SessionEventLogTailResult	Snapshot of the current tail cursor without returning any events.
SessionExtensionsApi	API methods for the extensions namespace.
SessionExtensionsDisableParams	Source-qualified extension identifier to disable for the session.
SessionExtensionsEnableParams	Source-qualified extension identifier to enable for the session.
SessionExtensionsListParams	Identifies the target session.
SessionExtensionsListResult	Extensions discovered for the session, with their current status.
SessionExtensionsReloadParams	Identifies the target session.
SessionExtensionsSendAttachmentsToMessageParams	Parameters for session.extensions.sendAttachmentsToMessage.
SessionFleetApi	API methods for the fleet namespace.
SessionFleetStartParams	Optional user prompt to combine with the fleet orchestration instructions.
SessionFleetStartResult	Indicates whether fleet mode was successfully activated.
SessionFsAppendFileParams	File path, content to append, and optional mode for the client-provided session filesystem.
SessionFsError	Describes a filesystem error.
SessionFsErrorCode	Error classification
SessionFsExistsParams	Path to test for existence in the client-provided session filesystem.
SessionFsExistsResult	Indicates whether the requested path exists in the client-provided session filesystem.
SessionFsMkdirParams	Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode.
SessionFsReaddirParams	Directory path whose entries should be listed from the client-provided session filesystem.
SessionFsReaddirResult	Names of entries in the requested directory, or a filesystem error if the read failed.
SessionFsReaddirWithTypesEntry	Schema for the `SessionFsReaddirWithTypesEntry` type.
SessionFsReaddirWithTypesEntryType	Entry type
SessionFsReaddirWithTypesParams	Directory path whose entries (with type information) should be listed from the client-provided session filesystem.
SessionFsReaddirWithTypesResult	Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed.
SessionFsReadFileParams	Path of the file to read from the client-provided session filesystem.
SessionFsReadFileResult	File content as a UTF-8 string, or a filesystem error if the read failed.
SessionFsRenameParams	Source and destination paths for renaming or moving an entry in the client-provided session filesystem.
SessionFsRmParams	Path to remove from the client-provided session filesystem, with options for recursive removal and force.
SessionFsSetProviderCapabilities	Optional capabilities declared by the provider
SessionFsSetProviderConventions	Path conventions used by this filesystem
SessionFsSetProviderParams	Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
SessionFsSetProviderResult	Indicates whether the calling client was registered as the session filesystem provider.
SessionFsSqliteExistsParams	Identifies the target session.
SessionFsSqliteExistsResult	Indicates whether the per-session SQLite database already exists.
SessionFsSqliteQueryParams	SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.
SessionFsSqliteQueryResult	Query results including rows, columns, and rows affected, or a filesystem error if execution failed.
SessionFsSqliteQueryType	How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected)
SessionFsStatParams	Path whose metadata should be returned from the client-provided session filesystem.
SessionFsStatResult	Filesystem metadata for the requested path, or a filesystem error if the stat failed.
SessionFsWriteFileParams	File path, content to write, and optional mode for the client-provided session filesystem.
SessionGitHubAuthApi	API methods for the gitHubAuth namespace.
SessionGitHubAuthGetStatusParams	Identifies the target session.
SessionGitHubAuthGetStatusResult	Authentication status and account metadata for the session.
SessionGitHubAuthSetCredentialsParams	New auth credentials to install on the session.
SessionGitHubAuthSetCredentialsResult	Indicates whether the credential update succeeded.
SessionHistoryAbortManualCompactionParams	Identifies the target session.
SessionHistoryAbortManualCompactionResult	Indicates whether an in-progress manual compaction was aborted.
SessionHistoryApi	API methods for the history namespace.
SessionHistoryCancelBackgroundCompactionParams	Identifies the target session.
SessionHistoryCancelBackgroundCompactionResult	Indicates whether an in-progress background compaction was cancelled.
SessionHistoryCompactParams	Optional compaction parameters.
SessionHistoryCompactResult	Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.
SessionHistorySummarizeForHandoffParams	Identifies the target session.
SessionHistorySummarizeForHandoffResult	Markdown summary of the conversation context (empty when not available).
SessionHistoryTruncateParams	Identifier of the event to truncate to; this event and all later events are removed.
SessionHistoryTruncateResult	Number of events that were removed by the truncation.
SessionInstalledPlugin	Schema for the `SessionInstalledPlugin` type.
SessionInstructionsApi	API methods for the instructions namespace.
SessionInstructionsGetSourcesParams	Identifies the target session.
SessionInstructionsGetSourcesResult	Instruction sources loaded for the session, in merge order.
SessionLimitsConfig	Optional session limits.
SessionLogLevel	Log severity level.
SessionLogParams	Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.
SessionLogResult	Identifier of the session event that was emitted for the log message.
SessionLspApi	API methods for the lsp namespace.
SessionLspInitializeParams	Parameters for (re)loading the merged LSP configuration set.
SessionMcpApi	API methods for the mcp namespace.
SessionMcpAppsApi	API methods for the mcp.apps namespace.
SessionMcpAppsCallToolParams	MCP server, tool name, and arguments to invoke from an MCP App view.
SessionMcpAppsDiagnoseParams	MCP server to diagnose MCP Apps wiring for.
SessionMcpAppsDiagnoseResult	Diagnostic snapshot of MCP Apps wiring for the named server.
SessionMcpAppsGetHostContextParams	Identifies the target session.
SessionMcpAppsGetHostContextResult	Current host context advertised to MCP App guests.
SessionMcpAppsListToolsParams	MCP server to list app-callable tools for.
SessionMcpAppsListToolsResult	App-callable tools from the named MCP server.
SessionMcpAppsReadResourceParams	MCP server and resource URI to fetch.
SessionMcpAppsReadResourceResult	Resource contents returned by the MCP server.
SessionMcpAppsSetHostContextParams	Host context to advertise to MCP App guests.
SessionMcpCancelSamplingExecutionParams	The requestId previously passed to executeSampling that should be cancelled.
SessionMcpCancelSamplingExecutionResult	Indicates whether an in-flight sampling execution with the given requestId was found and cancelled.
SessionMcpConfigureGitHubParams	Opaque auth info used to configure GitHub MCP.
SessionMcpConfigureGitHubResult	Result of configuring GitHub MCP.
SessionMcpDisableParams	Name of the MCP server to disable for the session.
SessionMcpEnableParams	Name of the MCP server to enable for the session.
SessionMcpExecuteSamplingParams	Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.
SessionMcpExecuteSamplingResult	Outcome of an MCP sampling execution: success result, failure error, or cancellation.
SessionMcpHeadersApi	API methods for the mcp.headers namespace.
SessionMcpHeadersHandlePendingHeadersRefreshRequestParams	MCP headers refresh request id and the host response.
SessionMcpHeadersHandlePendingHeadersRefreshRequestResult	Indicates whether the pending MCP headers refresh response was accepted.
SessionMcpIsServerRunningParams	Server name to check running status for.
SessionMcpIsServerRunningResult	Whether the named MCP server is running.
SessionMcpListParams	Identifies the target session.
SessionMcpListResult	MCP servers configured for the session, with their connection status and host-level state.
SessionMcpListToolsParams	Server name whose tool list should be returned.
SessionMcpListToolsResult	Tools exposed by the connected MCP server.
SessionMcpOauthApi	API methods for the mcp.oauth namespace.
SessionMcpOauthHandlePendingRequestParams	Pending MCP OAuth request ID and host-provided token or cancellation response.
SessionMcpOauthHandlePendingRequestResult	Indicates whether the pending MCP OAuth response was accepted.
SessionMcpOauthLoginParams	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.
SessionMcpOauthLoginResult	OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.
SessionMcpOauthRespondParams	MCP OAuth request id and optional provider response.
SessionMcpRegisterExternalClientParams	Registration parameters for an external MCP client.
SessionMcpReloadParams	Identifies the target session.
SessionMcpReloadWithConfigParams	Opaque MCP reload configuration.
SessionMcpReloadWithConfigResult	MCP server startup filtering result.
SessionMcpRemoveGitHubParams	Identifies the target session.
SessionMcpRemoveGitHubResult	Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).
SessionMcpRestartServerParams	Server name and opaque configuration for an individual MCP server restart.
SessionMcpSetEnvValueModeParams	Mode controlling how MCP server env values are resolved (`direct` or `indirect`).
SessionMcpSetEnvValueModeResult	Env-value mode recorded on the session after the update.
SessionMcpStartServerParams	Server name and opaque configuration for an individual MCP server start.
SessionMcpStopServerParams	Server name for an individual MCP server stop.
SessionMcpUnregisterExternalClientParams	Server name identifying the external client to remove.
SessionMetadataActivityParams	Identifies the target session.
SessionMetadataActivityResult	Current activity flags for the session.
SessionMetadataApi	API methods for the metadata namespace.
SessionMetadataContextInfoParams	Model identifier and token limits used to compute the context-info breakdown.
SessionMetadataContextInfoResult	Token breakdown for the session's current context window, or null if uninitialized.
SessionMetadataContextInfoResult.SessionMetadataContextInfoResultContextInfo	Token-usage breakdown for the session's current context window
SessionMetadataIsProcessingParams	Identifies the target session.
SessionMetadataIsProcessingResult	Indicates whether the local session is currently processing a turn or background continuation.
SessionMetadataRecomputeContextTokensParams	Model identifier to use when re-tokenizing the session's existing messages.
SessionMetadataRecomputeContextTokensResult	Re-tokenize the session's existing messages against `modelId` and return the token totals.
SessionMetadataRecordContextChangeParams	Updated working-directory/git context to record on the session.
SessionMetadataSetWorkingDirectoryParams	Absolute path to set as the session's new working directory.
SessionMetadataSetWorkingDirectoryResult	Update the session's working directory.
SessionMetadataSnapshotParams	Identifies the target session.
SessionMetadataSnapshotResult	Point-in-time snapshot of slow-changing session identifier and state fields
SessionMetadataSnapshotResult.SessionMetadataSnapshotResultWorkspace	Public-facing projection of workspace metadata for SDK / TUI consumers
SessionMode	The session mode the agent is operating in
SessionModeApi	API methods for the mode namespace.
SessionModeGetParams	Identifies the target session.
SessionModelApi	API methods for the model namespace.
SessionModelGetCurrentParams	Identifies the target session.
SessionModelGetCurrentResult	The currently selected model, reasoning effort, and context tier for the session.
SessionModelListParams	Optional listing options.
SessionModelListResult	The list of models available to this session.
SessionModelSetReasoningEffortParams	Reasoning effort level to apply to the currently selected model.
SessionModelSetReasoningEffortResult	Update the session's reasoning effort without changing the selected model.
SessionModelSwitchToParams	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
SessionModelSwitchToResult	The model identifier active on the session after the switch.
SessionModeSetParams	Agent interaction mode to apply to the session.
SessionNameApi	API methods for the name namespace.
SessionNameGetParams	Identifies the target session.
SessionNameGetResult	The session's friendly name, or null when not yet set.
SessionNameSetAutoParams	Auto-generated session summary to apply as the session's name when no user-set name exists.
SessionNameSetAutoResult	Indicates whether the auto-generated summary was applied as the session's name.
SessionNameSetParams	New friendly name to apply to the session.
SessionOptionsApi	API methods for the options namespace.
SessionOptionsUpdateParams	Patch of mutable session options to apply to the running session.
SessionOptionsUpdateResult	Indicates whether the session options patch was applied successfully.
SessionPermissionsApi	API methods for the permissions namespace.
SessionPermissionsConfigureParams	Patch of permission policy fields to apply (omit a field to leave it unchanged).
SessionPermissionsConfigureResult	Indicates whether the operation succeeded.
SessionPermissionsFolderTrustAddTrustedParams	Folder path to add to trusted folders.
SessionPermissionsFolderTrustAddTrustedResult	Indicates whether the operation succeeded.
SessionPermissionsFolderTrustApi	API methods for the permissions.folderTrust namespace.
SessionPermissionsFolderTrustIsTrustedParams	Folder path to check for trust.
SessionPermissionsFolderTrustIsTrustedResult	Folder trust check result.
SessionPermissionsGetAllowAllParams	No parameters.
SessionPermissionsGetAllowAllResult	Current full allow-all permission state.
SessionPermissionsHandlePendingPermissionRequestParams	Pending permission request ID and the decision to apply (approve/reject and scope).
SessionPermissionsHandlePendingPermissionRequestResult	Indicates whether the permission decision was applied; false when the request was already resolved.
SessionPermissionsLocationsAddToolApprovalParams	Location-scoped tool approval to persist.
SessionPermissionsLocationsAddToolApprovalResult	Indicates whether the operation succeeded.
SessionPermissionsLocationsApi	API methods for the permissions.locations namespace.
SessionPermissionsLocationsApplyParams	Working directory to load persisted location permissions for.
SessionPermissionsLocationsApplyResult	Summary of persisted location permissions applied to the session.
SessionPermissionsLocationsResolveParams	Working directory to resolve into a location-permissions key.
SessionPermissionsLocationsResolveResult	Resolved location-permissions key and type.
SessionPermissionsModifyRulesParams	Scope and add/remove instructions for modifying session- or location-scoped permission rules.
SessionPermissionsModifyRulesResult	Indicates whether the operation succeeded.
SessionPermissionsNotifyPromptShownParams	Notification payload describing the permission prompt that the client just rendered.
SessionPermissionsNotifyPromptShownResult	Indicates whether the operation succeeded.
SessionPermissionsPathsAddParams	Directory path to add to the session's allowed directories.
SessionPermissionsPathsAddResult	Indicates whether the operation succeeded.
SessionPermissionsPathsApi	API methods for the permissions.paths namespace.
SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams	Path to evaluate against the session's allowed directories.
SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult	Indicates whether the supplied path is within the session's allowed directories.
SessionPermissionsPathsIsPathWithinWorkspaceParams	Path to evaluate against the session's workspace (primary) directory.
SessionPermissionsPathsIsPathWithinWorkspaceResult	Indicates whether the supplied path is within the session's workspace directory.
SessionPermissionsPathsListParams	No parameters; returns the session's allow-listed directories.
SessionPermissionsPathsListResult	Snapshot of the session's allow-listed directories and primary working directory.
SessionPermissionsPathsUpdatePrimaryParams	Directory path to set as the session's new primary working directory.
SessionPermissionsPathsUpdatePrimaryResult	Indicates whether the operation succeeded.
SessionPermissionsPendingRequestsParams	No parameters; returns currently-pending permission requests for the session.
SessionPermissionsPendingRequestsResult	List of pending permission requests reconstructed from event history.
SessionPermissionsResetSessionApprovalsParams	No parameters; clears all session-scoped tool permission approvals.
SessionPermissionsResetSessionApprovalsResult	Indicates whether the operation succeeded.
SessionPermissionsSetAllowAllParams	Whether to enable full allow-all permissions for the session.
SessionPermissionsSetAllowAllResult	Indicates whether the operation succeeded and reports the post-mutation state.
SessionPermissionsSetApproveAllParams	Allow-all toggle for tool permission requests, with an optional telemetry source.
SessionPermissionsSetApproveAllResult	Indicates whether the operation succeeded.
SessionPermissionsSetRequiredParams	Toggles whether permission prompts should be bridged into session events for this client.
SessionPermissionsSetRequiredResult	Indicates whether the operation succeeded.
SessionPermissionsUrlsApi	API methods for the permissions.urls namespace.
SessionPermissionsUrlsSetUnrestrictedModeParams	Whether the URL-permission policy should run in unrestricted mode.
SessionPermissionsUrlsSetUnrestrictedModeResult	Indicates whether the operation succeeded.
SessionPlanApi	API methods for the plan namespace.
SessionPlanDeleteParams	Identifies the target session.
SessionPlanReadParams	Identifies the target session.
SessionPlanReadResult	Existence, contents, and resolved path of the session plan file.
SessionPlanReadSqlTodosParams	Identifies the target session.
SessionPlanReadSqlTodosResult	Todo rows read from the session SQL database.
SessionPlanReadSqlTodosWithDependenciesParams	Identifies the target session.
SessionPlanReadSqlTodosWithDependenciesResult	Todo rows + dependency edges read from the session SQL database.
SessionPlanUpdateParams	Replacement contents to write to the session plan file.
SessionPluginsApi	API methods for the plugins namespace.
SessionPluginsListParams	Identifies the target session.
SessionPluginsListResult	Plugins installed for the session, with their enabled state and version metadata.
SessionPluginsReloadParams	Optional flags controlling which side effects the reload performs.
SessionProviderAddParams	BYOK providers and/or models to add to the session's registry at runtime.
SessionProviderAddResult	The selectable model entries synthesized for the models added by this call.
SessionProviderApi	API methods for the provider namespace.
SessionProviderGetEndpointParams	Optional model identifier to scope the endpoint snapshot to.
SessionProviderGetEndpointResult	A snapshot of the provider endpoint the session is currently configured to talk to.
SessionQueueApi	API methods for the queue namespace.
SessionQueueClearParams	Identifies the target session.
SessionQueuePendingItemsParams	Identifies the target session.
SessionQueuePendingItemsResult	Snapshot of the session's pending queued items and immediate-steering messages.
SessionQueueRemoveMostRecentParams	Identifies the target session.
SessionQueueRemoveMostRecentResult	Indicates whether a user-facing pending item was removed.
SessionRemoteApi	API methods for the remote namespace.
SessionRemoteDisableParams	Identifies the target session.
SessionRemoteEnableParams	Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.
SessionRemoteEnableResult	GitHub URL for the session and a flag indicating whether remote steering is enabled.
SessionRemoteNotifySteerableChangedParams	New remote-steerability state to persist as a `session.remote_steerable_changed` event.
SessionRpc	Typed client for session-scoped RPC methods.
SessionsBulkDeleteParams	Session IDs to close, deactivate, and delete from disk.
SessionsBulkDeleteResult	Map of sessionId -> bytes freed by removing the session's workspace directory.
SessionsCheckInUseParams	Session IDs to test for live in-use locks.
SessionsCheckInUseResult	Session IDs from the input set that are currently in use by another process.
SessionScheduleApi	API methods for the schedule namespace.
SessionScheduleListParams	Identifies the target session.
SessionScheduleListResult	Snapshot of the currently active recurring prompts for this session.
SessionScheduleStopParams	Identifier of the scheduled prompt to remove.
SessionScheduleStopResult	Remove a scheduled prompt by id.
SessionsCloseParams	Session ID to close.
SessionsConfigureSessionExtensionsParams	Params to attach or detach an in-process ExtensionController delegate.
SessionsConnectParams	Remote session connection parameters.
SessionsConnectResult	Remote session connection result.
SessionSendParams	Parameters for sending a user message to the session
SessionSendResult	Result of sending a user message
SessionsEnrichMetadataParams	Session metadata records to enrich with summary and context information.
SessionsEnrichMetadataResult	The enriched metadata records, with summary and context fields backfilled where available.
SessionsFindByPrefixParams	UUID prefix to resolve to a unique session ID.
SessionsFindByPrefixResult	Session ID matching the prefix, omitted when no unique match exists.
SessionsFindByTaskIdParams	GitHub task ID to look up.
SessionsFindByTaskIdResult	ID of the local session bound to the given GitHub task, or omitted when none.
SessionsForkParams	Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.
SessionsForkResult	Identifier and optional friendly name assigned to the newly forked session.
SessionsGetBoardEntryCountParams	Session ID whose board entry count should be returned.
SessionsGetBoardEntryCountResult	Dynamic-context board entry count, when available.
SessionsGetEventFilePathParams	Session ID whose event-log file path to compute.
SessionsGetEventFilePathResult	Absolute path to the session's events.jsonl file on disk.
SessionsGetLastForContextParams	Optional working-directory context used to score session relevance.
SessionsGetLastForContextResult	Most-relevant session ID for the supplied context, or omitted when no sessions exist.
SessionsGetPersistedRemoteSteerableParams	Session ID to look up the persisted remote-steerable flag for.
SessionsGetPersistedRemoteSteerableResult	The session's persisted remote-steerable flag, or omitted when no value has been persisted.
SessionsGetRemoteControlStatusResult	Wrapper for the singleton's current status.
SessionsGetSizesResult	Map of sessionId -> on-disk size in bytes for each session's workspace directory.
SessionShellApi	API methods for the shell namespace.
SessionShellCancelUserRequestedParams	User-requested shell execution cancellation handle.
SessionShellCancelUserRequestedResult	Cancellation result for a user-requested shell command.
SessionShellExecParams	Shell command to run, with optional working directory and timeout in milliseconds.
SessionShellExecResult	Identifier of the spawned process, used to correlate streamed output and exit notifications.
SessionShellExecuteUserRequestedParams	User-requested shell command and cancellation handle.
SessionShellExecuteUserRequestedResult	Result of a user-requested shell command.
SessionShellKillParams	Identifier of a process previously returned by "shell.exec" and the signal to send.
SessionShellKillResult	Indicates whether the signal was delivered; false if the process was unknown or already exited.
SessionShutdownParams	Parameters for shutting down the session
SessionSkillsApi	API methods for the skills namespace.
SessionSkillsDisableParams	Name of the skill to disable for the session.
SessionSkillsEnableParams	Name of the skill to enable for the session.
SessionSkillsEnsureLoadedParams	Identifies the target session.
SessionSkillsGetInvokedParams	Identifies the target session.
SessionSkillsGetInvokedResult	Skills invoked during this session, ordered by invocation time (most recent last).
SessionSkillsListParams	Identifies the target session.
SessionSkillsListResult	Skills available to the session, with their enabled state.
SessionSkillsReloadParams	Identifies the target session.
SessionSkillsReloadResult	Diagnostics from reloading skill definitions, with warnings and errors as separate lists.
SessionsListResult	Sessions matching the filter, ordered most-recently-modified first.
SessionsLoadDeferredRepoHooksParams	Active session ID whose deferred repo-level hooks should be loaded.
SessionsLoadDeferredRepoHooksResult	Queued repo-level startup prompts and the total hook command count after loading.
SessionsOpenProgress	Schema for the `SessionsOpenProgress` type.
SessionsOpenProgressStatus	Step status.
SessionsOpenProgressStep	Handoff step.
SessionsOpenResult	Result of opening a session.
SessionsOpenStatus	Outcome of the open request.
SessionsPollSpawnedSessionsEvent	Schema for the `SessionsPollSpawnedSessionsEvent` type.
SessionsPollSpawnedSessionsResult	Batch of spawn events plus a cursor for follow-up polls.
SessionsPruneOldParams	Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).
SessionsPruneOldResult	Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
SessionsRegisterExtensionToolsOnSessionOptions	Optional registration options.
SessionsRegisterExtensionToolsOnSessionParams	Params to attach an extension loader's tools to a session.
SessionsRegisterExtensionToolsOnSessionResult	Handle for releasing the extension tool registration.
SessionsReleaseLockParams	Session ID whose in-use lock should be released.
SessionsReloadPluginHooksParams	Active session ID and an optional flag for deferring repo-level hooks until folder trust.
SessionsSaveParams	Session ID whose pending events should be flushed to disk.
SessionsSetAdditionalPluginsParams	Manager-wide additional plugins to register; replaces any previously-configured set.
SessionsSetRemoteControlSteeringParams	Patch for the singleton's steering state.
SessionsSetRemoteControlSteeringResult	Wrapper for the singleton's current status.
SessionsStartRemoteControlParams	Parameters for attaching the remote-control singleton to a session.
SessionsStartRemoteControlResult	Wrapper for the singleton's current status.
SessionsStopRemoteControlResult	Outcome of a stopRemoteControl call.
SessionsTransferRemoteControlParams	Parameters for atomically rebinding the remote-control singleton.
SessionsTransferRemoteControlResult	Outcome of a transferRemoteControl call.
SessionSuspendParams	Identifies the target session.
SessionTasksApi	API methods for the tasks namespace.
SessionTasksCancelParams	Identifier of the background task to cancel.
SessionTasksCancelResult	Indicates whether the background task was successfully cancelled.
SessionTasksGetCurrentPromotableParams	Identifies the target session.
SessionTasksGetCurrentPromotableResult	The first sync-waiting task that can currently be promoted to background mode.
SessionTasksGetProgressParams	Identifier of the background task to fetch progress for.
SessionTasksGetProgressResult	Progress information for the task, or null when no task with that ID is tracked.
SessionTasksListParams	Identifies the target session.
SessionTasksListResult	Background tasks currently tracked by the session.
SessionTasksPromoteCurrentToBackgroundParams	Identifies the target session.
SessionTasksPromoteCurrentToBackgroundResult	The promoted task as it now exists in background mode, omitted if no promotable task was waiting.
SessionTasksPromoteToBackgroundParams	Identifier of the task to promote to background mode.
SessionTasksPromoteToBackgroundResult	Indicates whether the task was successfully promoted to background mode.
SessionTasksRefreshParams	Identifies the target session.
SessionTasksRemoveParams	Identifier of the completed or cancelled task to remove from tracking.
SessionTasksRemoveResult	Indicates whether the task was removed.
SessionTasksSendMessageParams	Identifier of the target agent task, message content, and optional sender agent ID.
SessionTasksSendMessageResult	Indicates whether the message was delivered, with an error message when delivery failed.
SessionTasksStartAgentParams	Agent type, prompt, name, and optional description and model override for the new task.
SessionTasksStartAgentResult	Identifier assigned to the newly started background agent task.
SessionTasksWaitForPendingParams	Identifies the target session.
SessionTelemetryApi	API methods for the telemetry namespace.
SessionTelemetryGetEngagementIdParams	Identifies the target session.
SessionTelemetryGetEngagementIdResult	Telemetry engagement ID for the session, when available.
SessionTelemetrySetFeatureOverridesParams	Feature override key/value pairs to attach to subsequent telemetry events from this session.
SessionToolsApi	API methods for the tools namespace.
SessionToolsGetCurrentMetadataParams	Identifies the target session.
SessionToolsGetCurrentMetadataResult	Current lightweight tool metadata snapshot for the session.
SessionToolsHandlePendingToolCallParams	Pending external tool call request ID, with the tool result or an error describing why it failed.
SessionToolsHandlePendingToolCallResult	Indicates whether the external tool call result was handled successfully.
SessionToolsInitializeAndValidateParams	Identifies the target session.
SessionToolsUpdateSubagentSettingsParams	Subagent settings to apply to the current session
SessionToolsUpdateSubagentSettingsParams.SessionToolsUpdateSubagentSettingsParamsSubagents	Configured per-agent subagent overrides
SessionUiApi	API methods for the ui namespace.
SessionUiElicitationParams	Prompt message and JSON schema describing the form fields to elicit from the user.
SessionUiElicitationResult	The elicitation response (accept with form values, decline, or cancel)
SessionUiEphemeralQueryParams	Transient question to answer without adding it to conversation history.
SessionUiEphemeralQueryResult	Transient answer generated from current conversation context.
SessionUiHandlePendingAutoModeSwitchParams	Request ID of a pending `auto_mode_switch.requested` event and the user's response.
SessionUiHandlePendingAutoModeSwitchResult	Indicates whether the pending UI request was resolved by this call.
SessionUiHandlePendingElicitationParams	Pending elicitation request ID and the user's response (accept/decline/cancel + form values).
SessionUiHandlePendingElicitationResult	Indicates whether the elicitation response was accepted; false if it was already resolved by another client.
SessionUiHandlePendingExitPlanModeParams	Request ID of a pending `exit_plan_mode.requested` event and the user's response.
SessionUiHandlePendingExitPlanModeResult	Indicates whether the pending UI request was resolved by this call.
SessionUiHandlePendingSamplingParams	Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).
SessionUiHandlePendingSamplingResult	Indicates whether the pending UI request was resolved by this call.
SessionUiHandlePendingSessionLimitsExhaustedParams	Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action.
SessionUiHandlePendingSessionLimitsExhaustedResult	Indicates whether the pending UI request was resolved by this call.
SessionUiHandlePendingUserInputParams	Request ID of a pending `user_input.requested` event and the user's response.
SessionUiHandlePendingUserInputResult	Indicates whether the pending UI request was resolved by this call.
SessionUiRegisterDirectAutoModeSwitchHandlerParams	Identifies the target session.
SessionUiRegisterDirectAutoModeSwitchHandlerResult	Register an in-process handler for `auto_mode_switch.requested` events.
SessionUiUnregisterDirectAutoModeSwitchHandlerParams	Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.
SessionUiUnregisterDirectAutoModeSwitchHandlerResult	Indicates whether the handle was active and the registration count was decremented.
SessionUsageApi	API methods for the usage namespace.
SessionUsageGetMetricsParams	Identifies the target session.
SessionUsageGetMetricsResult	Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals.
SessionVisibilityApi	API methods for the visibility namespace.
SessionVisibilityGetParams	Identifies the target session.
SessionVisibilityGetResult	Current sharing status and shareable GitHub URL for a session.
SessionVisibilitySetParams	Desired sharing status for the session.
SessionVisibilitySetResult	Effective sharing status and shareable GitHub URL after updating session visibility.
SessionVisibilityStatus	Sharing status for a synced session.
SessionWorkingDirectoryContext	Updated working directory and git context.
SessionWorkingDirectoryContextHostType	Hosting platform type of the repository
SessionWorkspacesApi	API methods for the workspaces namespace.
SessionWorkspacesCreateFileParams	Relative path and UTF-8 content for the workspace file to create or overwrite.
SessionWorkspacesDiffParams	Parameters for computing a workspace diff.
SessionWorkspacesDiffResult	Workspace diff result for the requested mode.
SessionWorkspacesGetWorkspaceParams	Identifies the target session.
SessionWorkspacesGetWorkspaceResult	Current workspace metadata for the session, including its absolute filesystem path when available.
SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
SessionWorkspacesListCheckpointsParams	Identifies the target session.
SessionWorkspacesListCheckpointsResult	Workspace checkpoints in chronological order; empty when the workspace is not enabled.
SessionWorkspacesListFilesParams	Identifies the target session.
SessionWorkspacesListFilesResult	Relative paths of files stored in the session workspace files directory.
SessionWorkspacesReadCheckpointParams	Checkpoint number to read.
SessionWorkspacesReadCheckpointResult	Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.
SessionWorkspacesReadFileParams	Relative path of the workspace file to read.
SessionWorkspacesReadFileResult	Contents of the requested workspace file as a UTF-8 string.
SessionWorkspacesSaveLargePasteParams	Pasted content to save as a UTF-8 file in the session workspace.
SessionWorkspacesSaveLargePasteResult	Descriptor for the saved paste file, or null when the workspace is unavailable.
SessionWorkspacesSaveLargePasteResult.SessionWorkspacesSaveLargePasteResultSaved
ShellKillSignal	Signal to send (default: SIGTERM)
ShutdownType	Why the session is being shut down.
Skill	Schema for the `Skill` type.
SkillDiscoveryPath	Schema for the `SkillDiscoveryPath` type.
SkillDiscoveryScope	Which tier this directory belongs to
SkillsConfigSetDisabledSkillsParams	Skill names to mark as disabled in global configuration, replacing any previous list.
SkillsDiscoverParams	Optional project paths and additional skill directories to include in discovery.
SkillsDiscoverResult	Skills discovered across global and project sources.
SkillsGetDiscoveryPathsParams	Optional project paths to enumerate.
SkillsGetDiscoveryPathsResult	Canonical locations where skills can be created so the runtime will recognize them.
SkillsInvokedSkill	Schema for the `SkillsInvokedSkill` type.
SkillSource	Source location type (e.g., project, personal-copilot, plugin, builtin)
SlashCommandAgentPromptResult	Schema for the `SlashCommandAgentPromptResult` type.
SlashCommandCompletedResult	Schema for the `SlashCommandCompletedResult` type.
SlashCommandInfo	Schema for the `SlashCommandInfo` type.
SlashCommandInput	Optional unstructured input hint
SlashCommandInputCompletion	Optional completion hint for the input (e.g.
SlashCommandInvocationResult	Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection).
SlashCommandKind	Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned command
SlashCommandSelectSubcommandOption	Schema for the `SlashCommandSelectSubcommandOption` type.
SlashCommandSelectSubcommandResult	Schema for the `SlashCommandSelectSubcommandResult` type.
SlashCommandTextResult	Schema for the `SlashCommandTextResult` type.
SubagentSettingsEntry	Subagent model, reasoning effort, and context tier settings
SubagentSettingsEntryContextTier	Context tier override for matching subagents
Tool	Schema for the `Tool` type.
ToolsListParams	Optional model identifier whose tool overrides should be applied to the listing.
ToolsListResult	Built-in tools available for the requested model, with their parameters and instructions.
UIAutoModeSwitchResponse	User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline).
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
UIExitPlanModeAction	The action the user selected.
UIExitPlanModeResponse	Schema for the `UIExitPlanModeResponse` type.
UIHandlePendingSamplingResponse	Optional sampling result payload.
UISessionLimitsExhaustedResponse	The user's selected action for an exhausted session limit.
UISessionLimitsExhaustedResponseAction	User action selected for an exhausted session limit.
UIUserInputResponse	Schema for the `UIUserInputResponse` type.
UsageMetricsCodeChanges	Aggregated code change metrics
UsageMetricsModelMetric	Schema for the `UsageMetricsModelMetric` type.
UsageMetricsModelMetricRequests	Request count and cost metrics for this model
UsageMetricsModelMetricTokenDetail	Schema for the `UsageMetricsModelMetricTokenDetail` type.
UsageMetricsModelMetricUsage	Token usage metrics for this model
UsageMetricsTokenDetail	Schema for the `UsageMetricsTokenDetail` type.
UserSettingMetadata	A single user setting's effective value alongside its default, so consumers can render settings left at their default.
UserSettingsGetResult	Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default.
UserSettingsSetParams	Partial user settings to write to settings.json.
UserSettingsSetResult	Outcome of writing user settings.
WorkspaceDiffFileChange	A single changed file and its unified diff.
WorkspaceDiffFileChangeType	Type of change represented by this file diff.
WorkspaceDiffMode	Diff mode requested by the client.
WorkspacesCheckpoints	Schema for the `WorkspacesCheckpoints` type.
WorkspaceSummaryHostType	Repository host type, if known
WorkspacesWorkspaceDetailsHostType	Allowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration.