Get Agent Details

GET

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

AI Voice Agents

Last modified:2026-04-03 14:27:57

Retrieves the complete configuration for a single AI voice agent by its unique ID.

Returned configuration includes

Identity: agent name, description, assigned Twilio number.

Voice: voice model selection, language, speaking rate and tone.

Conversation: greeting message, main prompt/script, fallback responses.

Call handling: max call duration, silence timeout, transfer-to-human trigger conditions.

Notifications: email/SMS alert settings for call completion and transcription delivery.

Knowledge base: links to uploaded reference files used during conversations.

Routing: call direction (inbound/outbound), organization unit assignment.

Authorization
Access is restricted to agents owned by (or accessible to) the authenticated user's organization. Requesting an agent from another account returns a 401.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Agent retrieved successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/ai-voice-agents/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "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"
        ],
        "inherited_prompt_id": 12,
        "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"
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Create Agent

Update Agent