Class SessionProviderApi

java.lang.Object

com.github.copilot.generated.rpc.SessionProviderApi

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

API methods for the provider namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionProviderAddResult>	add(SessionProviderAddParams params)	BYOK providers and/or models to add to the session's registry at runtime.
CompletableFuture<SessionProviderGetEndpointResult>	getEndpoint()	Optional model identifier to scope the endpoint snapshot to.
CompletableFuture<SessionProviderGetEndpointResult>	getEndpoint(SessionProviderGetEndpointParams params)	Optional model identifier to scope the endpoint snapshot to.
CompletableFuture<SessionProviderSyncResult>	sync(SessionProviderSyncParams params)	Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
CompletableFuture<SessionProviderWithdrawResult>	withdraw(SessionProviderWithdrawParams params)	Host-managed model selection ids to withdraw from the session's BYOK registry.

Methods inherited from class Object

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

Method Details

getEndpoint

@CopilotExperimental
public CompletableFuture<SessionProviderGetEndpointResult> getEndpoint()

Optional model identifier to scope the endpoint snapshot to.

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

Since:

1.0.0

getEndpoint

@CopilotExperimental
public CompletableFuture<SessionProviderGetEndpointResult> getEndpoint(SessionProviderGetEndpointParams params)

Optional model identifier to scope the endpoint snapshot to.

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

Since:

1.0.0

add

@CopilotExperimental
public CompletableFuture<SessionProviderAddResult> add(SessionProviderAddParams params)

BYOK providers and/or models to add to the session's registry at runtime. Both fields are optional; provide providers, models, or both.

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

Since:

1.0.0

sync

@CopilotExperimental
public CompletableFuture<SessionProviderSyncResult> sync(SessionProviderSyncParams params)

Authoritative BYOK provider and model registry snapshot to apply atomically to the session.

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

Since:

1.0.0

withdraw

@CopilotExperimental
public CompletableFuture<SessionProviderWithdrawResult> withdraw(SessionProviderWithdrawParams params)

Host-managed model selection ids to withdraw from the session's BYOK registry.

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

Since:

1.0.0