Update a conversational agent

Updates the target agent (latest version by default, or specific version if provided) with the supplied data. These changes are saved to either a new draft or update an existing draft. Returns the version ID of the draft.

The new version of the agent will not be used by default until it is released.

PUT /conversational_agents/{id}

Update a conversational agent

cURL

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": null,
  "description": null
}
'

200

{
  "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

name · string

Human-readable name for the agent.

description · string

Description of the agent.

config · conversational.agent.config · object

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

Show child attributes

postprocess_agents · string[]

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

Response

200

application/json

Successful response.

id · string · required

Unique identifier for the agent, e.g. ca_8qm9JBCiTe7

version_id · string · required

Version-specific identifier for the draft representing the new agent instance, e.g. ca_8qm9JBCiTe7@v1. Can be further passed to the release API endpoint.