Documentation - AIVA.help

Overview

The AIVA API allows you to programmatically access call data, manage appointments, and integrate AIVA with your existing systems. Our REST API uses standard HTTP methods and returns JSON responses.

Base URL: All API requests should be made to https://api.aiva.help/v1/

API Versioning

The current API version is v1. We include the version in the URL path to ensure backward compatibility as we release new features.

Quick Start

Get started with the AIVA API in under 5 minutes. This guide will walk you through making your first API call.

1. Get Your API Key

Navigate to your AIVA dashboard → Settings → API Keys → Generate New Key. Store this key securely — it won't be shown again.

2. Make Your First Request

# List recent calls
curl -X GET https://api.aiva.help/v1/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
                

3. Check the Response

{
  "data": [
    {
      "id": "call_abc123",
      "duration": 180,
      "status": "completed",
      "caller_name": "John Smith",
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 156,
    "page": 1
  }
}
                

Authentication

All API requests require authentication using a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

API keys are scoped to your account and have access to all resources within your organization. Never share your API key or commit it to version control.

Calls API

GET /v1/calls

List all calls with optional filtering by date range, status, or phone number.

GET /v1/calls/{call_id}

Retrieve details for a specific call, including transcript and caller information.

GET /v1/calls/{call_id}/transcript

Get the full conversation transcript for a specific call.

Appointments API

GET /v1/appointments

List all appointments booked through AIVA.

POST /v1/appointments

Create a new appointment programmatically.

PUT /v1/appointments/{appointment_id}

Update an existing appointment (reschedule, change details).

DELETE /v1/appointments/{appointment_id}

Cancel an appointment.

Webhooks

Webhooks allow you to receive real-time notifications when events occur in AIVA. Configure webhook endpoints in your dashboard to receive POST requests for:

call.started — When a new call begins
call.completed — When a call ends
appointment.created — When an appointment is booked
appointment.cancelled — When an appointment is cancelled

Need more help? Contact our developer support team at hello@aiva.help