Skip to main content

A request for an agent. GraphAgentRequest -> GraphAgent

id
RegistryAgentIdentifier · object
required

The ID of this agent in the registry

name
string
required

A given name for this agent in the session/group

provider
linked · object
required

The agent will be provided by a linked server

description
string

An optional override for the description of this agent

options
LinkedHashMap<String,AgentOptionValue> · object

The arguments to pass to the agent

systemPrompt
string

The system prompt/developer text/preamble passed to the agent

blocking
boolean

All blocking agents in a group must be instantiated before the group can communicate. Non-blocking agents' contributions to groups are optional

customToolAccess
string[]

A list of custom tools that this agent can access. The custom tools must be defined in the parent AgentGraphRequest object

plugins
GraphAgentPlugin · object[]

Plugins that should be installed on this agent. See GraphAgentPlugin for more information

x402Budgets
X402BudgetedResource · object[]

An optional list of resources and an accompanied budget that this agent may spend on services that accept x402 payments

annotations
LinkedHashMap<String,String> · object