Skip to main content

Voice Agents

A Voice Agent is an AI persona — name, role, voice configuration, and language — that drives calls. Agents are reusable across multiple campaigns.

List voice agents​

GET /api/voice/agents

Returns all active voice agents for the organisation.

curl "https://api.nextneural.ai/api/voice/agents" \
-H "Authorization: Bearer nn_k_your_key"

Response:

[
{
"uuid": "agt_a1b2c3d4",
"name": "Aria",
"role": "Outbound Sales",
"description": "Multilingual outbound agent for retail sales",
"avatar_color": "#6366f1",
"avatar_initials": "AR",
"voice_config": {
"provider": "nextneural",
"model": "neuralvoice",
"speaker": "anushka",
"language_code": "hi-IN",
"sample_url": "https://cdn.nextneural.ai/samples/anushka.mp3"
},
"is_active": true,
"created_at": "2026-05-01T10:00:00Z"
}
]

Get voice agent​

GET /api/voice/agents/{agent_uuid}

Path parameters:

  • agent_uuid (string, required)

Create voice agent​

POST /api/voice/agents — Rate limit: 20/minute

Request body:

{
"name": "Aria",
"role": "Outbound Sales",
"description": "Multilingual outbound agent for retail sales",
"avatar_color": "#6366f1",
"avatar_initials": "AR",
"voice_config": {
"provider": "nextneural",
"model": "neuralvoice",
"speaker": "anushka",
"language_code": "hi-IN"
}
}
FieldTypeRequiredNotes
namestring✓
rolestring✓
descriptionstring—
avatar_colorstring—Hex colour
avatar_initialsstring—1–2 characters
voice_configobject—provider, model, speaker, language_code

Update voice agent​

PATCH /api/voice/agents/{agent_uuid}

Partial update. All fields optional, same schema as create.


Delete voice agent​

DELETE /api/voice/agents/{agent_uuid}

Soft delete — sets is_active = false. Does not affect running calls.


List voice samples​

GET /api/voice/samples

Returns available TTS voice samples from all connected providers.

Query parameters:

ParamTypeNotes
providerstringFilter by nextneural, sarvam, elevenlabs
language_codestringe.g. hi-IN, en-IN

Response:

[
{
"uuid": "vs_x1y2z3",
"provider": "nextneural",
"model": "neuralvoice",
"speaker": "anushka",
"language_code": "hi-IN",
"language_name": "Hindi",
"url": "https://cdn.nextneural.ai/samples/anushka.mp3"
}
]