Get a conversational agent
curl --request GET \
--url https://api.operator.xyz/conversational_agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Operator-Version: <operator-version>'import requests
url = "https://api.operator.xyz/conversational_agents/{id}"
headers = {
"Operator-Version": "<operator-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Operator-Version': '<operator-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.operator.xyz/conversational_agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"version_id": "<string>",
"name": "<string>",
"description": "<string>",
"version_status": "released",
"config": {
"personas": [
{
"name": "<string>",
"voice": {
"id": "Female 1",
"provider": "operator"
}
}
],
"voice": {
"boosted_keywords": [
"<string>"
],
"ambient_sound": null,
"busy_sound": null
},
"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": [
{
"id": "<string>"
}
]
},
"language": {
"default_language": "English",
"supported_languages": [
"English"
]
},
"channel": {
"is_voicemail_enabled": true
}
},
"postprocess_agents": [
"<string>"
]
}{
"code": "<string>",
"message": "<string>",
"data": "<unknown>"
}Conversational agents
Get a conversational agent
GET
/
conversational_agents
/
{id}
Get a conversational agent
curl --request GET \
--url https://api.operator.xyz/conversational_agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Operator-Version: <operator-version>'import requests
url = "https://api.operator.xyz/conversational_agents/{id}"
headers = {
"Operator-Version": "<operator-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Operator-Version': '<operator-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.operator.xyz/conversational_agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"version_id": "<string>",
"name": "<string>",
"description": "<string>",
"version_status": "released",
"config": {
"personas": [
{
"name": "<string>",
"voice": {
"id": "Female 1",
"provider": "operator"
}
}
],
"voice": {
"boosted_keywords": [
"<string>"
],
"ambient_sound": null,
"busy_sound": null
},
"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": [
{
"id": "<string>"
}
]
},
"language": {
"default_language": "English",
"supported_languages": [
"English"
]
},
"channel": {
"is_voicemail_enabled": true
}
},
"postprocess_agents": [
"<string>"
]
}{
"code": "<string>",
"message": "<string>",
"data": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The API version to use.
Available options:
2025-06-19 Path Parameters
The ID of the agent to retrieve. Use ca_8qm9JBCiTe7 for the latest version, or ca_8qm9JBCiTe7@v2 for a specific version.
Response
Successful response.
Unique identifier for the agent, e.g. ca_8qm9JBCiTe7
Version-specific identifier for the agent instance, e.g. ca_8qm9JBCiTe7@v0
Human-readable name for the agent.
Description of the agent.
Status of this agent version: 'released', 'draft', or 'archived'.
Available options:
released, draft, archived Full configuration for the agent (e.g. voice, runtime, tools).
Show child attributes
Show child attributes
List of postprocessing procedural agent IDs that run after the conversation ends, e.g. ["pa_8qm9JBCiTe7"]

