Developer Hub

Build on
KaiVox AI

Integrate KaiVox into your product with our REST API and real-time webhooks. 16 endpoints, HMAC-signed events, and full documentation — everything you need to connect your stack.

Get API Keys (Free Trial) Technology Partner Program

16 API endpoints

Real-time webhooks

HMAC-SHA256 signing

Bearer token auth

List appointments — GET /api/v1/appointments

curl -X GET \
  https://kaivoxai.com/api/v1/appointments \
  -H "Authorization: Bearer kv_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"date_from":"2026-06-01","status":"scheduled"}'

// Response
{
  "success": true,
  "data": [{
    "id": 1234,
    "customer_name": "Anita Sharma",
    "service": "Consultation",
    "start_time": "2026-06-15T10:00:00Z",
    "status": "scheduled"
  }],
  "meta": { "total": 47, "page": 1 }
}

REST API — 16 Endpoints across 5 Resources

All endpoints use JSON. Authentication via Bearer token or X-API-Key header. Standardised response format with pagination metadata.

Appointments

Full CRUD — list, create, show, update status, cancel. Plus available slots.

GET /api/v1/appointments POST /api/v1/appointments GET /api/v1/appointments/{id} PATCH /api/v1/appointments/{id} DELETE /api/v1/appointments/{id} GET /api/v1/appointments/slots

Customers

List with search and filter. Create, show, update segment and pipeline stage.

GET /api/v1/customers POST /api/v1/customers GET /api/v1/customers/{id} PATCH /api/v1/customers/{id}

Calls

List with sentiment and date filters. Show individual call with full transcript.

GET /api/v1/calls GET /api/v1/calls/{id}

Staff

List active staff with availability. Show individual staff member.

GET /api/v1/staff GET /api/v1/staff/{id}

Services

List active services. Show individual service with pricing and duration.

GET /api/v1/services GET /api/v1/services/{id}

Real-Time Webhooks

Subscribe to KaiVox events and get instant HTTP POST notifications to your endpoint. Every event is signed with HMAC-SHA256 so you can verify it's genuinely from KaiVox.

appointment.booked New appointment confirmed

appointment.cancelled Appointment cancelled

call.completed Call ended with transcript + sentiment

call.missed Missed call logged

customer.created New customer added to CRM

HMAC-SHA256 Signing

Every webhook payload includes an X-KaiVox-Signature header. Verify it against your webhook secret to ensure authenticity. Delivery log tracks every attempt with HTTP status + retry on failure (max 3).

Webhook payload — appointment.booked POST → your-endpoint.com

{
  "event": "appointment.booked",
  "timestamp": "2026-06-15T10:00:00Z",
  "tenant_id": 42,
  "data": {
    "appointment_id": 1234,
    "customer_name": "Anita Sharma",
    "customer_phone": "+91 98765 43210",
    "service": "General Consultation",
    "staff": "Dr. Sharma",
    "appointment_date": "2026-06-20",
    "start_time": "10:30:00",
    "booked_via": "voice_call"
  }
}

// Headers
X-KaiVox-Signature: sha256=abc123...
X-KaiVox-Event: appointment.booked
Content-Type: application/json

Authentication

Three ways to authenticate with the KaiVox API.

Bearer Token (Recommended)

Include your API key in the Authorization header. Recommended for server-to-server requests.

Authorization: Bearer kv_live_xxxxxxxxxx

X-API-Key Header

Alternative header authentication. Useful when the Authorization header is already in use by your infrastructure.

X-API-Key: kv_live_xxxxxxxxxx

Query Parameter

Append your API key as a URL parameter. Convenient for testing but not recommended for production.

GET /api/v1/appointments?api_key=kv_live_xxx

What You Can Build

Real integration scenarios our developer partners are already building.

EHR / EMR Integration

Sync appointments booked via KaiVox voice AI directly into your EMR system. Patient name, service, time — all automatically transferred.

Healthcare · Dental · Mental Health

POS / Booking System Sync

Push KaiVox appointments into your existing booking software. Avoid double-booking and keep your front desk and back-office in sync.

Salons · Gyms · Restaurants

Custom Notifications

Listen to missed_call and appointment.cancelled webhooks to trigger your own notification flows — Slack alerts, custom SMS, internal dashboards.

All industries

Business Intelligence

Pull call logs, sentiment scores, and appointment data into your BI tool (Looker, Metabase, Tableau) for cross-system reporting.

Agencies · Enterprise

AI Workflow Orchestration

Use KaiVox webhooks to trigger downstream AI workflows — qualify leads from calls, auto-update CRM, or create tasks in your project management tool.

Agencies · Tech companies

White Label Reseller Platform

Build a fully custom branded front-end on top of the KaiVox API. Your UI, your UX, KaiVox intelligence powering everything behind it.

Resellers · Product companies

Rate Limits

Plan	Requests/min	Requests/day
Starter	30 req/min	5,000/day
Pro	100 req/min	20,000/day
Enterprise	500 req/min	100,000/day

Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset.

Standard Response Format

// Success
{
  "success": true,
  "data": { /* resource or array */ },
  "meta": { "page": 1, "total": 47 }
}

// Error
{
  "success": false,
  "message": "Appointment not found",
  "errors": { /* validation details */ }
}
                    

Build onKaiVox AI