Sign up

API Documentation

Everything you need to integrate Voice ava in minutes.

Base URL
https://api.vira-id.ir/webhook/call
Authentication

All requests must include your API key in the Authorization header.

Authorization: Bearer vx_live_...

Create a new analysis request

POSThttps://api.vira-id.ir/webhook/call/create

Uploads one audio file for analysis and returns the generated ID that must be used with /details.

Body Parameters

titlestring

Call title.

audiobinaryrequired

Required. The audio file to analyze.

fieldsarray

Select the list of features you want to receive from this audio file. If not provided, the default value defined in your profile will be used.

Allowed values:summarycustomer_satisfactionproductsprioritization
extra_datastring

Additional information that helps with better call analysis.

langstring

Spoken-language code such as en, fa, ar, or de.

Allowed values:enfaarde
Authentication
Token : YOUR_API_KEY
Parameters
title:string
audio*:binary
fields:array
extra_data:string
lang:string
Request Sample: Shell / cURL
curl --request POST \
  --url https://api.vira-id.ir/webhook/call/create \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --form 'title=test' \
  --form 'audio=@call.mp3' \
  --form 'fields=["summary", "products"]' \
  --form 'extra_data=Customer name is Sadegh' \
  --form 'lang=en'
Response Example
{
  "result": {
    "id": 1842
  }
}

Get analysis status or final result

GEThttps://api.vira-id.ir/webhook/call/details

Checks whether analysis is finished. Keep calling this endpoint with the same ID until the response says completed: true.

Query Parameters

idintegerrequired

Required. The ID returned by POST /create.

Authentication
Token : YOUR_API_KEY
Parameters
id*:integer
Request Sample: Shell / cURL
curl --request GET \
  --url 'https://api.vira-id.ir/webhook/call/details?id=1842' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Response Example
{
  "completed": true,
  "result": {
    "id": 1842,
    "title": "Enterprise pricing follow-up",
    "duration": 501,
    "speakers": 2,
    "summary": "Customer is interested in the annual plan but needs confirmation on pricing, SSO rollout, and legal review timing.",
    "customer_satisfaction": 4,
    "sections": [],
    "token": 348,
    "created_at": "2026-05-11T09:14:22Z",
    "prioritization": {
      "conversion_chance": 78,
      "loss_chance": 18,
      "urgency": 85,
      "required_effort": "medium"
    },
    "products": [
      {
        "id": 12,
        "sentiment": "positive",
        "intent": "purchase",
        "issues": [
          "legal review"
        ],
        "likes": [
          "annual discount"
        ],
        "dislikes": [
          "SSO timing"
        ]
      }
    ]
  }
}

Update profile

POSThttps://api.vira-id.ir/webhook/call/profile

Updates the authenticated user's profile context. This matches the existing dashboard profile save request.

Body Parameters

namestring

User full name.

emailstringrequired

User email address.

company_namestring

Company name used for analysis context.

phonestring

User phone number.

descriptionstring

Company and product context that improves AI accuracy.

productsarray

List of products with numeric id and name fields.

Authentication
Token : YOUR_API_KEY
Parameters
name:string
email*:string
company_name:string
phone:string
description:string
products:array
Request Sample: Shell / cURL
curl --request POST \
  --url https://api.vira-id.ir/webhook/call/profile \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sara Ahmadi",
    "email": "sara@example.com",
    "company_name": "Voice ava Retail",
    "phone": "+989121234567",
    "description": "We sell support and sales automation software.",
    "products": [
      { "id": 1, "name": "Enterprise plan" }
    ]
  }'
Response Example
{
  "result": {
    "name": "Sara Ahmadi",
    "email": "sara@example.com",
    "company_name": "Voice ava Retail",
    "phone": "+989121234567",
    "description": "We sell support and sales automation software.",
    "token": 1200,
    "products": [
      { "id": 1, "name": "Enterprise plan" }
    ]
  }
}