Skip to main content
GET
Get a procedural agent

Authorizations

Authorization
string
header
required

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

Headers

Operator-Version
enum<string>
required

The API version to use.

Available options:
2025-06-19

Path Parameters

id
string
required

The ID of the procedural agent to retrieve. Use pa_8qm9JBCiTe7 for the latest version, or pa_8qm9JBCiTe7@v2 for a specific version.

Response

Successful response.

id
string
required

Unique identifier for the procedural agent, e.g. pa_8qm9JBCiTe7

version_id
string
required

Version-specific identifier for the procedural agent instance, e.g. pa_8qm9JBCiTe7@v0

name
string
required

Human-readable name for the procedural agent.

description
string
required

Description of the procedural agent.

version_status
enum<string>
required

Status of this procedural agent version: 'released', 'draft', or 'archived'.

Available options:
released,
draft,
archived
config
procedural.agent.config · object
required

Full configuration for the procedural agent (e.g. runtime, tools, output).

triggered_by_agents
procedural.agent.triggered.by.summary · object[]

A summary description of the conversational agents that trigger this procedural agent.