curl --request POST \
--url https://apiv2.vodex.ai/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "+919876543210",
"fromNumberId": "<string>",
"contactRef": "<string>",
"variables": {}
}
'import requests
url = "https://apiv2.vodex.ai/v1/calls"
payload = {
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "+919876543210",
"fromNumberId": "<string>",
"contactRef": "<string>",
"variables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toNumber: '+919876543210',
fromNumberId: '<string>',
contactRef: '<string>',
variables: {}
})
};
fetch('https://apiv2.vodex.ai/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.vodex.ai/v1/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toNumber' => '+919876543210',
'fromNumberId' => '<string>',
'contactRef' => '<string>',
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/calls"
payload := strings.NewReader("{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.vodex.ai/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"callId": "call-…",
"room": "<string>",
"to": "<string>",
"from": "<string>",
"cell": "us-central1"
}{
"error": "not found"
}{
"error": "call minutes exhausted — 30 of 30 minutes used this month",
"code": "quota_exhausted",
"plan": "<string>",
"period": "2026-08",
"usedMinutes": 123,
"limitMinutes": 123
}{
"error": "not found"
}Place an outbound call
Returns as soon as the room exists and the INVITE is on its way — it does not wait for an answer, which takes seconds. The call is recorded in the calls list from this moment, so a carrier rejection (which produces no trace at all, because no agent ever joins) is visible rather than a call that simply never rings; the outcome lands on the row.
contactRef is an opaque reference of yours, echoed back on the webhook
— put your own account or record id there, and the end-of-call report
joins to your data without matching on a phone number.
variables are per-call {{var}} values merged over the assistant’s own.
curl --request POST \
--url https://apiv2.vodex.ai/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "+919876543210",
"fromNumberId": "<string>",
"contactRef": "<string>",
"variables": {}
}
'import requests
url = "https://apiv2.vodex.ai/v1/calls"
payload = {
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "+919876543210",
"fromNumberId": "<string>",
"contactRef": "<string>",
"variables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toNumber: '+919876543210',
fromNumberId: '<string>',
contactRef: '<string>',
variables: {}
})
};
fetch('https://apiv2.vodex.ai/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.vodex.ai/v1/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toNumber' => '+919876543210',
'fromNumberId' => '<string>',
'contactRef' => '<string>',
'variables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/calls"
payload := strings.NewReader("{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.vodex.ai/v1/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"+919876543210\",\n \"fromNumberId\": \"<string>\",\n \"contactRef\": \"<string>\",\n \"variables\": {}\n}"
response = http.request(request)
puts response.read_body{
"callId": "call-…",
"room": "<string>",
"to": "<string>",
"from": "<string>",
"cell": "us-central1"
}{
"error": "not found"
}{
"error": "call minutes exhausted — 30 of 30 minutes used this month",
"code": "quota_exhausted",
"plan": "<string>",
"period": "2026-08",
"usedMinutes": 123,
"limitMinutes": 123
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.
"+919876543210"
A phone-number id (num-…) or its E.164 value.
256At most 16 kB serialized.
Show child attributes
Show child attributes
Callbacks
POST{$request.body#/webhookUrl}interactionCompleted
Body
The payload Vodex POSTs to your endpoint — not something this API
serves. Documented here because it is the contract configured through
PUT /v1/webhook-config.
interaction.completed, not call.completed: one stream for every
channel, so a consumer writes one handler and switches on channel
rather than integrating a new webhook when SMS or WhatsApp ships.
It is deliberately complete — a consumer that receives this needs no
follow-up GET. analysis is an open envelope: summary and sentiment
land there as additive keys, so a handler written today keeps parsing
tomorrow's payloads.
Headers
| Header | Meaning |
|---|---|
x-vodex-signature | t=<unix>,v1=<hex> where v1 = HMAC-SHA256(secret, "<t>.<raw body>") |
x-vodex-event | The event type |
x-vodex-delivery | Delivery id — the same event retried keeps its id, so use that for idempotency |
The timestamp is inside the signed string, not merely alongside it:
signing the body alone leaves a captured delivery replayable forever,
because nothing in what was signed says when it was sent. Reject
anything more than 300 seconds off in either direction. During a
rotation both secrets sign, as repeated v1= values, so consumers can
move without a coordinated deploy.
Retries
8 attempts at 10s, 30s, 2m, 10m, 30m, 2h, 6h, each with full jitter
(a random point in [0, delay], so a consumer coming back from an
outage is not hit by every queued delivery at the same instant). 408,
429, 5xx and transport failures retry; every other 4xx does not —
repeating a request the consumer called wrong just burns the budget a
real outage needs. A delivery that exhausts its attempts is the dead
letter — status: failed with no nextAttemptAt — and stays visible at
GET /v1/webhook-deliveries.
interaction.completed Idempotency key — stable across retries.
voice-ai, sms Echoed from the dial request, never interpreted.
The counterparty address, for when no contactRef was passed.
Orthogonal facts, never a prose string — a consumer should never have to sniff a string for what happened.
Show child attributes
Show child attributes
Turn-level, with offsets in seconds from the first traced event.
Show child attributes
Show child attributes
Open envelope — additive keys only.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
References, never bytes — audio is resolved through the authed API when a user presses play, so it never leaves its region unbidden.
Show child attributes
Show child attributes
Exactly what the agent knew, frozen at call time — the assistant's config may have changed since.
Show child attributes
Show child attributes
Response
Retried — a timeout is transient.