Voice AI Agent Quickstart

Welcome to Vozzo Voice AI Agents. In this guide you will create a fully functional AI voice agent, retrieve its UUID, and make your first API call — all in under 5 minutes.

What is a Voice AI Agent?

A Vozzo Voice AI Agent is a programmable conversational AI that speaks naturally over phone and web channels. Each agent has its own:

• Identity — name, language, accent, avatar
• Intelligence — LLM model, STT/TTS pipeline, knowledge base
• Personality — greeting, behaviour, system prompt
• Deployment — web widget or phone number

Prerequisites

Step 1 — Create an Agent

Create your first agent by specifying the voice, language, and model.

cURL
 
# Using API Key
curl -X POST https://backend.vozzo.ai/agent/create-agent/ \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "Support Bot",
    "org_id": 1,
    "voice_id": 935,
    "agent_language": "English",
    "agent_accent": "",
    "vz_model_id": 2
  }'

JavaScript
 
const response = await fetch(
  "https://backend.vozzo.ai/agent/create-agent/",
  {
    method: "POST",
    headers: {
      Authorization: "Token YOUR_API_KEY", // Or "Bearer YOUR_JWT"
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      agent_name: "Support Bot",
      org_id: 1,
      voice_id: 935,
      agent_language: "English",
      agent_accent: "",
      vz_model_id: 2,
    }),
  },
);
const { data } = await response.json();
console.log("Agent UUID:", data.agent_uuid);

Successful response:

Code
 
{
  "success": true,
  "message": "Agent created successfully",
  "data": {
    "agent_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "agent_name": "Support Bot",
    "vz_model_id": 2
  }
}

Step 2 — Retrieve Agent Details

Fetch the full configuration of your newly created agent using its UUID.

cURL
 
curl -X GET https://backend.vozzo.ai/agent/get-agent/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Token YOUR_API_KEY"

Step 3 — List All Agents

To view all agents created under your organization, along with their assigned phone numbers, voice models, language, and conversation counts, call the /agent/list-agent/ endpoint. You can paginate results using skip and limit, or filter by name using search.

cURL
 
curl -X GET "https://backend.vozzo.ai/agent/list-agent/?skip=0&limit=10&search=Support" \
  -H "Authorization: Token YOUR_API_KEY"

JavaScript
 
const response = await fetch("https://backend.vozzo.ai/agent/list-agent/?skip=0&limit=10", {
  method: "GET",
  headers: {
    Authorization: "Token YOUR_API_KEY",
    accept: "application/json",
  },
});
const { data } = await response.json();
console.log("Total agents:", data.total);
console.log("Agents list:", data.agents);

Response Example:

Code
 
{
  "success": true,
  "message": "Agents fetched successfully",
  "data": {
    "total": 1,
    "agents": [
      {
        "agent_id": 12,
        "agent_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "agent_name": "Support Bot",
        "agent_type": "inbound_outbound",
        "agent_phones": [
          {
            "agent_phone": "+18005550199",
            "country_code": "US"
          }
        ],
        "agent_avatar": {
          "key": "dev/avatars/agent-icon-3.png"
        },
        "call_type": "web_phone",
        "agent_prompt": "You are a helpful support agent for Acme Corp. Be concise and friendly.",
        "agent_tools": null,
        "agent_voice": "en-US-Standard-C",
        "agent_language": "English",
        "agent_accent": "US",
        "is_agent_greet_first": true,
        "agent_behaviour": "Polite and professional",
        "conversation_count": 42,
        "created_time": "2026-01-15 10:30:00",
        "updated_time": "2026-02-01 14:20:00",
        "created_by": "admin@vozzo.ai",
        "updated_by": "admin@vozzo.ai",
        "is_analytics_required": true,
        "is_comprehend_required": false,
        "is_context_trim_enabled": false,
        "max_context_items": null
      }
    ]
  }
}

Step 4 — Update Agent Personality

Personalize your agent with a greeting and a system prompt that defines its persona.

cURL
 
curl -X PUT https://backend.vozzo.ai/agent/update-agent/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_greeting": "Hello! I am your AI assistant. How can I help you today?",
    "agent_prompt": "You are a helpful support agent for Acme Corp. Be concise and friendly.",
    "is_agent_greet_first": true
  }'

What's Next?