Class SessionAgentApi

java.lang.Object

com.github.copilot.generated.rpc.SessionAgentApi

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

API methods for the agent namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	deselect()	Clears the selected custom agent and returns the session to the default agent.
CompletableFuture<SessionAgentGetCurrentResult>	getCurrent()	Gets the currently selected custom agent for the session.
CompletableFuture<SessionAgentListResult>	list()	Lists agents available to the session.
CompletableFuture<SessionAgentListResult>	list(SessionAgentListParams params)	Lists agents available to the session.
CompletableFuture<SessionAgentReloadResult>	reload()	Reloads custom agent definitions and returns the refreshed list.
CompletableFuture<SessionAgentSelectResult>	select(SessionAgentSelectParams params)	Selects a custom agent for subsequent turns in the session.
CompletableFuture<Void>	setPrompt(SessionAgentSetPromptParams params)	Sets an in-memory authored prompt override for an available agent.

Methods inherited from class Object

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

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionAgentListResult> list()

Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents.

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

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionAgentListResult> list(SessionAgentListParams params)

Lists agents available to the session. Defaults to custom agents only; pass includeBuiltInAgents to include the effective built-in agents.

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

Since:

1.0.0

setPrompt

@CopilotExperimental
public CompletableFuture<Void> setPrompt(SessionAgentSetPromptParams params)

Sets an in-memory authored prompt override for an available agent. For built-in agents, this replaces only the static base prompt while preserving runtime-owned dynamic prompt composition and behavior. The special `general-purpose` agent is not overrideable. Overrides are not persisted; resumed and forked sessions start without them, so the host must re-apply them.

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

Since:

1.0.0

getCurrent

@CopilotExperimental
public CompletableFuture<SessionAgentGetCurrentResult> getCurrent()

Gets the currently selected custom agent for the session.

Since:

1.0.0

select

@CopilotExperimental
public CompletableFuture<SessionAgentSelectResult> select(SessionAgentSelectParams params)

Selects a custom agent for subsequent turns in 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

deselect

@CopilotExperimental
public CompletableFuture<Void> deselect()

Clears the selected custom agent and returns the session to the default agent.

Since:

1.0.0

reload

@CopilotExperimental
public CompletableFuture<SessionAgentReloadResult> reload()

Reloads custom agent definitions and returns the refreshed list.

Since:

1.0.0