Skip to main content
POST

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"

Body

application/json

Create a pool in INACTIVE state. Validate and persist membership atomically.

metadata
object
required

CreateResourceMetadata contains the user-provided fields for creating 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
required

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

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.