Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

id
string
required

AgentPool ID. Accepts the canonical apool_… form or the external_id:<value> form.

Example:

"apool_01HXKD2E5NQM3T9AYWCF2R43QW"

Body

application/json

Update agent pool request

metadata
object

UpdateResourceMetadata contains the user-provided fields for updating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.

spec
object

Partial input for UpdateAgentPool. The server applies update_mask, then validates the resulting AgentPoolSpec before persisting any changes.

updateMask
string<field-mask>

Fields to update. Only metadata and spec are mutable; top-level state and info paths are invalid. spec.assignments replaces the entire membership list. A spec mask replaces the full spec; * replaces all mutable fields. Without a mask, infer paths from non-empty fields. Empty or omitted membership then leaves the existing list unchanged. Element/index paths are invalid. Validate the merged pool atomically: an empty description or membership (including an explicitly masked empty list) is invalid.

Response

OK

A workspace-scoped group of agents. When assigned to a variation, the pool exposes one callable target that routes a request to a member agent. Pool membership references agents; variation assignments reference the pool.

metadata
object
required

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

spec
object
required

AgentPoolSpec describes the pool's purpose, membership, input schema, and routing instructions.

state
enum<string>
required
read-only

Output only. Pools are created INACTIVE. Use :activate, :deactivate, :archive, and :unarchive to transition states. Unarchive returns INACTIVE.

Available options:
AGENT_POOL_STATE_UNSPECIFIED,
AGENT_POOL_STATE_ACTIVE,
AGENT_POOL_STATE_INACTIVE,
AGENT_POOL_STATE_ARCHIVED
info
object

AgentPoolInfo represents the information of an agent pool.