PUT
/
conversational_agents
/
{id}
Update a conversational agent
curl --request PUT \
  --url https://api.operator.xyz/conversational_agents/{id} \
  --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",
          "id": "Female 1"
        }
      }
    ],
    "voice": {
      "ambient_sound": null,
      "busy_sound": null,
      "boosted_keywords": [
        "<string>"
      ]
    },
    "runtime": {
      "model": "openai/gpt-4o",
      "prompt": {
        "text": "<string>",
        "type": "fixed"
      },
      "variables": [
        {
          "name": "<string>",
          "description": "<string>",
          "default_value": null
        }
      ]
    },
    "tool": {
      "tools": [
        {
          "ns": "syscall",
          "name": "<string>"
        }
      ],
      "transfers": [
        {
          "entity_id": "<string>"
        }
      ]
    },
    "language": {
      "default_language": "English",
      "supported_languages": [
        "English"
      ]
    },
    "channel": {
      "is_voicemail_enabled": true,
      "is_sms_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

Path Parameters

​
id
string
required

The ID of the agent to update. Use ca_8qm9JBCiTe7 for the latest version, or ca_8qm9JBCiTe7@v2 for a specific version.

Body

application/json

Response

200
application/json

Successful response.

The response is of type object.