Skip to main content
POST
/
conversational_agents
Create a conversational agent
curl --request POST \
  --url https://api.operator.xyz/conversational_agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Operator-Version: <operator-version>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "config": {
    "personas": [
      {
        "name": "<string>",
        "voice": {
          "provider": "operator"
        }
      }
    ],
    "voice": {
      "boosted_keywords": [
        "<string>"
      ],
      "ambient_sound": null,
      "busy_sound": null
    },
    "runtime": {
      "prompt": {
        "text": "<string>",
        "type": "fixed"
      },
      "variables": [
        {
          "name": "<string>",
          "description": "<string>",
          "default_value": null
        }
      ]
    },
    "tool": {
      "tools": [
        {
          "name": "<string>"
        }
      ],
      "transfers": [
        {
          "id": "<string>"
        }
      ]
    },
    "language": {
      "supported_languages": []
    },
    "channel": {
      "is_voicemail_enabled": true
    }
  }
}
'
{
  "id": "<string>",
  "version_id": "<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

Body

application/json
​
name
string
required

Human-readable name for the agent.

​
description
string
required

Description of the agent.

​
config
conversational.agent.config · object
required

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

​
postprocess_agents
string[]

List of postprocessing procedural agent IDs that run after the conversation ends, e.g. ["pa_8qm9JBCiTe7"]

Response

Successful response.

​
id
string
required

Unique identifier for the agent, e.g. ca_8qm9JBCiTe7

​
version_id
string
required

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