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
Attachment	Represents a file attachment to include with a message.
AzureOptions	Azure OpenAI-specific configuration options.
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.
GetAuthStatusResponse	Response from the auth.getStatus 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.
GetStatusResponse	Response from the status.get RPC call.
InfiniteSessionConfig	Configuration for infinite sessions with automatic context compaction and workspace persistence.
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.
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.
PingResponse	Response from a ping request to the Copilot CLI server.
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.
SendMessageRequest	Internal request object for sending a message to a session.
SendMessageResponse	Internal response object from sending a message.
SessionConfig	Configuration for creating a new Copilot session.
SessionMetadata	Metadata about an existing Copilot session.
SystemMessageConfig	Configuration for customizing the system message.
ToolBinaryResult	Binary result from a tool execution.
ToolDef	Low-level tool definition for JSON-RPC communication.
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.