Class SessionModelApi

java.lang.Object

com.github.copilot.generated.rpc.SessionModelApi

@Generated("copilot-sdk-codegen")
public final class SessionModelApi
extends Object

API methods for the model namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionModelApplyStartupOverlayResult>	applyStartupOverlay(SessionModelApplyStartupOverlayParams params)	Managed, repository, and CLI model overrides to overlay onto the session at startup.
CompletableFuture<SessionModelGetCurrentResult>	getCurrent()	Identifies the target session.
CompletableFuture<SessionModelListResult>	list()	Optional listing options.
CompletableFuture<SessionModelListResult>	list(SessionModelListParams params)	Optional listing options.
CompletableFuture<SessionModelSetAllowedModelsResult>	setAllowedModels(SessionModelSetAllowedModelsParams params)	Host-supplied exact model selection IDs to allow for this running session.
CompletableFuture<SessionModelSetReasoningEffortResult>	setReasoningEffort(SessionModelSetReasoningEffortParams params)	Reasoning effort level to apply to the currently selected model.
CompletableFuture<SessionModelSwitchAutoTierResult>	switchAutoTier(SessionModelSwitchAutoTierParams params)	An Auto preference request for the session.
CompletableFuture<SessionModelSwitchToResult>	switchTo(SessionModelSwitchToParams params)	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getCurrent

@CopilotExperimental
public CompletableFuture<SessionModelGetCurrentResult> getCurrent()

Identifies the target session.

Since:

1.0.0

switchTo

@CopilotExperimental
public CompletableFuture<SessionModelSwitchToResult> switchTo(SessionModelSwitchToParams params)

Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

switchAutoTier

@CopilotExperimental
public CompletableFuture<SessionModelSwitchAutoTierResult> switchAutoTier(SessionModelSwitchAutoTierParams params)

An Auto preference request for the session. This updates Auto configuration only; it does not change the selected model to `auto`.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

applyStartupOverlay

@CopilotExperimental
public CompletableFuture<SessionModelApplyStartupOverlayResult> applyStartupOverlay(SessionModelApplyStartupOverlayParams params)

Managed, repository, and CLI model overrides to overlay onto the session at startup.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

setAllowedModels

@CopilotExperimental
public CompletableFuture<SessionModelSetAllowedModelsResult> setAllowedModels(SessionModelSetAllowedModelsParams params)

Host-supplied exact model selection IDs to allow for this running session. CAPI IDs are intersected with repository `.github/allowed_models.txt` policy; provider-qualified IDs remain exempt from repository-only policy but are restricted by this host list. Omit or pass null to clear the host restriction; an explicit empty or disjoint list is rejected. Validation and pre-selection fallback failures preserve the previous restriction. Failures after a fallback selection commits retain the new restriction and selected model; callers should inspect current session state after such an error.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

setReasoningEffort

@CopilotExperimental
public CompletableFuture<SessionModelSetReasoningEffortResult> setReasoningEffort(SessionModelSetReasoningEffortParams params)

Reasoning effort level to apply to the currently selected model.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionModelListResult> list()

Optional listing options.

Invokes the method with no params, applying the runtime defaults.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionModelListResult> list(SessionModelListParams params)

Optional listing options.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0