Package com.github.copilot.sdk.json

package com.github.copilot.sdk.json

Configuration classes and data transfer objects for the Copilot SDK.

This package contains all the configuration, request, response, and data transfer objects used throughout the SDK. These classes are designed for JSON serialization with Jackson and provide fluent setter methods for convenient configuration.

Client Configuration

• CopilotClientOptions - Options for configuring the CopilotClient, including CLI path, port, transport mode, and auto-start behavior.

Session Configuration

• SessionConfig - Configuration for creating a new session, including model selection, tools, system message, and MCP server configuration.
• ResumeSessionConfig - Configuration for resuming an existing session.
• InfiniteSessionConfig - Configuration for infinite sessions with automatic context compaction.
• SystemMessageConfig - System message customization options.

Message and Tool Configuration

• MessageOptions - Options for sending messages, including prompt text and attachments.
• ToolDefinition - Definition of a custom tool that can be invoked by the assistant.
• ToolInvocation - Represents a tool invocation request from the assistant.
• Attachment - File attachment for messages.

Provider Configuration (BYOK)

• ProviderConfig - Configuration for using your own API keys with custom providers (OpenAI, Azure, etc.).
• AzureOptions - Azure-specific configuration options.

Model Information

• ModelInfo - Information about an available AI model.
• ModelCapabilities - Model capabilities and limits.
• ModelPolicy - Model policy and state information.

Custom Agents

• CustomAgentConfig - Configuration for custom agents with specialized behaviors and tools.

Permissions

• PermissionHandler - Handler for permission requests from the assistant.
• PermissionRequest - A permission request from the assistant.
• PermissionRequestResult - Result of a permission request decision.

Usage Example

 var config = new SessionConfig().setModel("gpt-4.1").setStreaming(true)
 		.setSystemMessage(new SystemMessageConfig().setMode(SystemMessageMode.APPEND)
 				.setContent("Be concise in your responses."))
 		.setTools(List.of(ToolDefinition.create("my_tool", "Description", schema, handler)));

 var session = client.createSession(config).get();
 

See Also:

• CopilotClient
• CopilotSession

Related Packages

Package	Description
com.github.copilot.sdk	Core classes for the GitHub Copilot SDK for Java.
com.github.copilot.sdk.events	Event types emitted during Copilot session processing.

Class	Description
AgentInfo	Represents a custom agent available for selection in a session.
Attachment	Represents a file attachment to include with a message.
AzureOptions	Azure OpenAI-specific configuration options.
BlobAttachment	Represents an inline base64-encoded binary attachment (blob) for messages.
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.
CommandHandler	Functional interface for handling slash-command executions.
CommandWireDefinition	Wire-format representation of a command definition for RPC serialization.
CopilotClientOptions	Configuration options for creating a CopilotClient.
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.
DeleteSessionResponse	Internal response object from deleting a session.
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.
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.
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.
HookInvocation	Context for a hook invocation.
InfiniteSessionConfig	Configuration for infinite sessions with automatic context compaction and workspace persistence.
InputOptions	Options for the SessionUiApi.input(String, InputOptions) convenience method.
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.
MessageAttachment	Marker interface for all attachment types that can be included in a message.
MessageOptions	Options for sending a message to a Copilot session.
ModelBilling	Model billing information.
ModelCapabilities	Model capabilities and limits.
ModelInfo	Information about an available model.
ModelLimits	Model limits.
ModelPolicy	Model policy state.
ModelSupports	Model support flags.
ModelVisionLimits	Model vision-specific limits.
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.
PermissionRequestResult	Result of a permission request decision.
PermissionRequestResultKind	Describes the outcome kind of a permission request result.
PingResponse	Response from a ping request to the Copilot CLI server.
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.
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.
SessionCapabilities	Represents the capabilities reported by the host for a session.
SessionConfig	Configuration for creating a new Copilot session.
SessionContext	Working directory context for a session.
SessionEndHandler	Handler for session-end hooks.
SessionEndHookInput	Input for a session-end hook.
SessionEndHookOutput	Output for a session-end hook.
SessionHooks	Hook handlers configuration for a session.
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.
SessionMetadata	Metadata about an existing Copilot session.
SessionStartHandler	Handler for session-start hooks.
SessionStartHookInput	Input for a session-start hook.
SessionStartHookOutput	Output for a session-start hook.
SessionUiApi	Provides UI methods for eliciting information from the user during a session.
SessionUiCapabilities	UI-specific capability flags for a session.
SetForegroundSessionResponse	Response from session.setForeground RPC call.
SystemMessageConfig	Configuration for customizing the system message.
SystemPromptSections	Well-known system prompt section identifiers for use with SystemMessageMode#CUSTOMIZE mode.
TelemetryConfig	OpenTelemetry configuration for the Copilot CLI server.
ToolBinaryResult	Binary result from a tool execution.
ToolDefinition	Defines a tool that can be invoked by the AI assistant.
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.
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.
UserInputResponse	Response to a user input request.
UserPromptSubmittedHandler	Handler for user-prompt-submitted hooks.
UserPromptSubmittedHookInput	Input for a user-prompt-submitted hook.
UserPromptSubmittedHookOutput	Output for a user-prompt-submitted hook.