List AI Voice Agents

GET

https://platform-api.convirza.com/v3/ai-voice-agents

AI Voice Agents

Last modified:2026-07-24 13:10:44

Returns a paginated list of AI voice agents configured in the authenticated user's account.

What is an AI Voice Agent?
An AI voice agent is an automated conversational assistant that handles inbound or outbound phone calls using natural language processing. Each agent has a unique voice, greeting script, conversation prompts, and call handling configuration.

Filtering

status — filter by lifecycle state: active, inactive, or deleted (default: active).

search — full-text search across agent name and metadata fields. Useful for finding agents by campaign or use case.

Sorting

sort_by — field to sort on (default: created_on).

sort_order — asc or desc (default: desc, newest first).

Pagination
Use limit and offset to page through large agent libraries. The response includes a total count.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Agent list retrieved successfully

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/ai-voice-agents?id=&org_unit_ids=&limit=&offset=&status=&search=&sort_by=&sort_order=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "items": [
            {
                "id": 101,
                "primary_phone_number": "+14255551234",
                "prompt": "You are a professional sales assistant for Convirza. Your goal is to qualify inbound leads, answer product questions, and schedule demos. Always be concise, friendly, and focused on the caller's needs.",
                "greetings": "Thank you for calling Convirza! How can I assist you today?",
                "voiceagent_type_id": 1,
                "voice_id": 3,
                "voiceagent_name": "Sales Assistant — Inbound Leads",
                "type": "conversational",
                "voice": "alloy",
                "created_on": "2026-01-15T10:30:00.000Z",
                "updated_on": "2026-03-20T14:20:00.000Z",
                "status": "active",
                "direction": "inbound",
                "more_information": "Prioritize callers who mention pricing or demo requests. Escalate to a human if the caller expresses frustration.",
                "urls": [
                    "https://docs.example.com/faq",
                    "https://www.example.com/pricing"
                ],
                "config": {
                    "background_noise": false,
                    "volume": 0.8,
                    "block_non_intelliquent_number": true
                },
                "max_call_duration": 300,
                "notification_time": 60,
                "notification_message": "This call will end in 1 minute.",
                "org_unit_id": 1001,
                "knowledgebase_files": [
                    "product-catalog.pdf",
                    "sales-playbook.docx"
                ],
                "knowledgebase_urls": [
                    "https://docs.example.com/guide",
                    "https://www.example.com/faq"
                ]
            }
        ],
        "total": 50
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Delete Prompt

Get Agent Details