Follow Avox Docs on Google
Pick Avox Docs as a preferred source and Google shows these pages more often when you search for help with Avox.
Follow Avox Docs on Google
Pick Avox Docs as a preferred source and Google shows these pages more often when you search for help with Avox.
Every endpoint of the builder API, the scope it needs, and where its full description with examples lives. Start with Builder API quick start for keys, permissions, paging, versions, retries and limits. An AI assistant should read API for AI assistants first.
All paths start with https://api.avox.com. "Write" endpoints are refused for test keys.
The examples on these pages use this small JavaScript helper:
const avox = (path, init = {}) =>
fetch(`https://api.avox.com/api/v1${path}`, {
...init,
headers: { Authorization: `Bearer ${process.env.AVOX_API_KEY}`, "Content-Type": "application/json", ...init.headers },
}).then((res) => res.json());
curl https://api.avox.com/api/v1/me -H "Authorization: Bearer $AVOX_API_KEY"
const { data } = await avox("/me");
{
"ok": true,
"request_id": "req_4f1c9a0b7e2d36a8c5b1f0e9",
"data": {
"key": { "id": "8d2f...", "name": "Booking assistant", "prefix": "avx_live_Qm3", "mode": "live", "scopes": ["send", "tables:read", "tables:write", "rows:read", "rows:write"], "scopesSummary": "Send, Tables (write), Table rows (write)", "createdAt": "2026-10-23T08:00:00Z", "expiresAt": null },
"switchboard": { "id": "b1c2...", "name": "Riverside Salon", "paused": false },
"whatsappNumber": { "id": "c3d4...", "name": "Front desk", "number": "+91 98••••3210", "status": "connected" },
"plan": { "name": "Your plan" },
"limits": {
"apiCallsToday": { "reads": { "used": 12, "limit": 1234 }, "writes": { "used": 3, "limit": 123 }, "resetsAt": "2026-10-24T00:00:00.000Z" },
"tables": { "used": 2, "limit": 9 },
"rowsPerTable": { "limit": 9999 },
"columnsPerTable": { "limit": 50 },
"rowsPerRequest": { "limit": 1000 },
"flows": { "used": 1, "limit": 9 },
"templates": { "used": 4, "limit": 9 },
"automations": { "used": 2, "limit": 9, "active": 1, "activeLimit": 9 },
"liveRequestsThisMonth": { "used": 140, "limit": 9999 }
},
"docs": { "forAiAssistants": "https://docs.avox.com/avox-api/ai-assistants", "openapi": "https://docs.avox.com/openapi.json" }
}
}
The numbers above are made up: yours come from your plan (see Plans).
curl https://api.avox.com/api/v1/catalog -H "Authorization: Bearer $AVOX_API_KEY"
const { data } = await avox("/catalog");
const appointments = data.tables.find((t) => t.id === "appointments");
{
"ok": true,
"request_id": "req_...",
"data": {
"tables": [{ "id": "appointments", "name": "Appointments", "kind": "calendar", "columns": [{ "key": "customer", "name": "Customer", "type": "text", "required": true, "unique": false }], "sampleRows": 3 }],
"flows": [{ "id": "appointment_booking", "title": "Appointment booking", "category": "APPOINTMENT_BOOKING", "live": true, "tables": [{ "ref": "slots", "premadeTableId": "time-slots", "purpose": "The free times customers pick from" }, { "ref": "bookings", "premadeTableId": "appointments", "purpose": "Where each booking is saved" }] }],
"templates": [{ "id": "booking_reminder", "title": "Booking reminder (day before)", "kind": "custom", "category": "UTILITY", "languages": ["en_US", "hi"], "defaultLanguage": "en_US", "mediaHeader": null, "body": "Hi {{1}}, this is a reminder of your {{2}} booking on {{3}} at {{4}}. ..." }],
"automations": [{ "id": "booking_reminder_day", "name": "Reminder a day before each booking", "triggerType": "table_date", "needs": { "tables": ["appointments"], "apps": [], "approvedTemplate": true, "publishedFlow": false, "calling": false }, "suggestedTemplate": "booking_reminder", "creditsPerRunAtMost": 2 }],
"types": { "columnTypes": ["text", "long_text", "number", "currency", "..."], "flowCategories": ["SIGN_UP", "..."], "triggerTypes": ["keyword", "..."], "actionTypes": ["send_text", "..."] },
"scopes": { "all": ["send", "tables:read", "..."] }
}
}
Full descriptions and examples: Tables and rows.
Full descriptions and examples: Flows.
Full descriptions and examples: Templates.
Full descriptions and examples: Automations.
Last updated