AgentClient
Class: AgentClient
Defined in: packages/sdk/src/backend/agents.ts:453
Control-plane client for the Agents product.
Constructors
Constructor
new AgentClient(
config):AgentClient
Defined in: packages/sdk/src/backend/agents.ts:457
Parameters
config
PlatformConfig
Returns
AgentClient
Methods
agent()
agent(
name):AgentHandle
Defined in: packages/sdk/src/backend/agents.ts:565
Bind a handle to an agent.
Parameters
name
string
Returns
configureAgent()
configureAgent(
name,opts):Promise<AgentDescription>
Defined in: packages/sdk/src/backend/agents.ts:510
Parameters
name
string
opts
fallbackMessage?
string
flow?
FlowGraph | null
Pass null to clear the flow (revert to the default linear pipeline).
guardrails?
instructions?
string
model?
string
streamMode?
"buffered" | "live"
toolPolicy?
uiActions?
Returns
Promise<AgentDescription>
createAgent()
createAgent(
opts):Promise<AgentDescription>
Defined in: packages/sdk/src/backend/agents.ts:481
Parameters
opts
Returns
Promise<AgentDescription>
deleteAgent()
deleteAgent(
name):Promise<{deleted:string; }>
Defined in: packages/sdk/src/backend/agents.ts:557
Parameters
name
string
Returns
Promise<{ deleted: string; }>
deleteSecret()
deleteSecret(
name):Promise<{deleted:string; }>
Defined in: packages/sdk/src/backend/agents.ts:550
Parameters
name
string
Returns
Promise<{ deleted: string; }>
describeAgent()
describeAgent(
name):Promise<AgentDescription>
Defined in: packages/sdk/src/backend/agents.ts:503
Parameters
name
string
Returns
Promise<AgentDescription>
listAgents()
listAgents():
Promise<AgentDescription[]>
Defined in: packages/sdk/src/backend/agents.ts:496
Returns
Promise<AgentDescription[]>
listSecrets()
listSecrets():
Promise<string[]>
Defined in: packages/sdk/src/backend/agents.ts:545
List the names of stored project secrets (values are never returned).
Returns
Promise<string[]>
setSecret()
setSecret(
name,value):Promise<{name:string; }>
Defined in: packages/sdk/src/backend/agents.ts:538
Store a project secret for tool auth (M2). Write-only — value is never
returned. Reference it from a tool via secretRef.
Parameters
name
string
value
string
Returns
Promise<{ name: string; }>