AgentVersion

A version of an agent: its model, instructions, summary and tools.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
aiModelId	uuid	The id of the catalogue model the agent runs on.
systemPrompt	string	The agent’s standing instructions (its system prompt): who it is and how it behaves.
summaryForOtherAgents	string	One line that describes the agent to other agents: a router choosing who answers, or a manager choosing who to hand work to, reads it.
externalOperationReferences	AgentExternalOperationReference[]	The tools the agent may call in every interaction it takes part in.
routedSubAgents	VersionReference[] | null	When set, this agent is a router and never does the work itself: on every turn it is given, its model reads what is in front of it and picks one of these agents (by their summaries, guided by this agent’s prompt) to take the turn in its place. A router can be bound anywhere an agent can, and a candidate may itself be a router. Null or empty: an ordinary agent.
allowSwarm	boolean	Whether this agent may start sub-interactions when an interaction it takes part in lets its participants. Both must say yes; either can say no. A router never takes a turn, so never has this.
allowWebSearch	boolean	Whether this agent is given the built-in web search tool. An interaction can switch it per participant, and a run per agent. A router never takes a turn, so never has this.
allowWebFetch	boolean	Whether this agent is given the built-in web fetch tools, which read any URL (a page, document or image) as text and read on through a long one. What it fetches is kept in its run’s web-download knowledge base. It can be switched per participant and per run, like allowWebSearch.
version	integer	The version number, from 1. Every change to a definition adds a new version with the next number.
date	datetime	When this version was created, in UTC.
isDisabled	boolean	Whether this version is disabled. A disabled version is never used: new links and runs take the latest enabled version, and anything pinned to this one fails until it is re-enabled.

Example

{
  "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,
  "version": 0,
  "date": "2026-10-26T12:00:00.0000000Z",
  "isDisabled": false
}

Where it’s used

• Inside Agent