GET
/
procedural_agents
/
{id}
Get a procedural agent
curl --request GET \
  --url https://api.operator.xyz/procedural_agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Operator-Version: <operator-version>'
{
  "id": "<string>",
  "version_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version_status": "released",
  "config": {
    "filter_statuses": [
      "completed"
    ],
    "filter_condition": null,
    "runtime": {
      "model": "openai/gpt-4o",
      "reasoning_effort": "medium",
      "prompt": {
        "text": "<string>",
        "type": "fixed"
      }
    },
    "tool": {
      "tools": [
        {
          "ns": "syscall",
          "name": "<string>"
        }
      ]
    },
    "output": {
      "slack_channel": null,
      "output_schema": null,
      "post_url": null
    }
  },
  "triggered_by_agents": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

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
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.