Skip to content

AgentCreateRequest

Creates an agent: a model with standing instructions, a one-line summary and the tools it may use.

Kind: an object, used in requests.

FieldTypeRequiredDescription
namestringyesThe agent’s name, unique within its namespace. Constraints: maxLength: 150, required (empty or whitespace-only strings are rejected).
aiModelIduuidyesThe id of the catalogue model the agent runs on. Constraints: required (empty or whitespace-only strings are rejected).
systemPromptstringyesThe agent’s standing instructions (its system prompt): who it is and how it behaves. Constraints: required (empty or whitespace-only strings are rejected).
summaryForOtherAgentsstringyesOne line that describes the agent to other agents: a router choosing who answers, or a manager choosing who to hand work to, reads it. Constraints: required (empty or whitespace-only strings are rejected).
externalOperationReferencesAgentExternalOperationReferenceInput[]The tools the agent may call in every interaction it takes part in.
routedSubAgentsVersionReference[] | nullMakes the agent a router: on every turn it is given, its model picks one of these agents (by their summaries, guided by systemPrompt) to take the turn instead. The first is the fallback. A router has no tools of its own.
allowSwarmbooleanWhether the agent may start sub-interactions where an interaction it takes part in allows them.
allowWebSearchbooleanWhether the agent is given the built-in web search tool. An omitted value is false.
allowWebFetchbooleanWhether the agent is given the built-in web fetch tools. An omitted value is false.
{
"name": "...",
"aiModelId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
"systemPrompt": "...",
"summaryForOtherAgents": "...",
"externalOperationReferences": [
{
"externalOperationId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
"externalOperationVersion": 0,
"promptGuidance": "..."
}
],
"routedSubAgents": [
{
"id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
"version": 0
}
],
"allowSwarm": false,
"allowWebSearch": false,
"allowWebFetch": false
}