#AiDial API Reference

• Production API: https://api.aidial.ai
• Version prefix: /v1

This reference documents public endpoints and approved customer/partner API surfaces. Internal operations, host names, route mappings, storage layout, and deployment details are deliberately excluded.

#Getting Started

• Authentication - API key and bearer authentication, credential precedence, and security guidance
• Partner Integrations - partner identity, API keys, webhooks, catalogs, and capacity
• Error Responses - error formats and status code reference
• Rate Limiting - handling 429 responses and retry strategy
• Deprecation Policy - deprecation status, notice process, and non-GA endpoint handling

#Endpoint Groups

Protected routes use the authentication mode shown on each endpoint page. Partner server-to-server integrations normally use X-API-Key; customer or partner portal flows may use Authorization: Bearer <jwt> only when the page explicitly says so.

#Partner Integrations

Identity, API-key lifecycle, webhook registration, model/voice catalogs, and capacity monitoring for approved partner integrations.

#Calls Analytics

Call summaries, lists, timeline metrics, sentiment, outcomes, provider performance, privacy aggregates, call detail, transcript download and PDF, and CSV export for authenticated tenant scopes.

#Projects

Project lifecycle, assignments, controlled release operations, safe project-secret metadata, and legacy project billing helpers for authorised scopes.

#Outbound Campaigns

Outbound campaign CRUD, contact import, compliance validation, registry-wash records, and safe outbound-evidence summaries.

#Compliance Caller Requests

Masked caller access/deletion workflow rows, open-count badges, and lifecycle status transitions.

#Billing

Customer billing overview, invoice history, invoice recipient masking/unmasking, invoice PDF download, and billing portal sessions.

#Health & Status

Public availability endpoints for GET / and GET /v1/health.

#Data Scoping

Protected API responses are scoped to the authenticated context. Cross-client data is never returned. Out-of-scope resources return 404 Not Found to avoid tenant enumeration. Missing or invalid authentication returns 401 Unauthorized. Server-side misconfiguration, such as a missing tenant data route, returns 500 Internal Server Error. If a required backend dependency is unavailable, the API returns 503 Service Unavailable.

PII-sensitive responses respect customer privacy settings and fail closed by redacting or omitting protected fields when access cannot be verified. Raw encrypted values, ciphertext, wrapped key material, and bearer tokens are never response fields. Generated API-key and webhook signing secrets are returned only in the create and rotate responses that mint them, once, and cannot be retrieved afterwards; see Partner Integrations.

#Endpoint Coverage

This table lists every mounted route classified as public or partner in the internal endpoint visibility manifest. Mounted routes classified as internal are intentionally excluded from this table. Some internal routes are first-party AiDial Portal contracts and are not part of this public API reference.