#Partner Integrations
Identity, API-key lifecycle, webhook registration, model/voice catalogs, and capacity monitoring for approved partner integrations.
- Production API:
https://api.aidial.ai - Version prefix:
/v1
Use X-API-Key for server-to-server requests unless AiDial has explicitly provisioned a portal bearer flow for your integration. Do not send both X-API-Key and Authorization: Bearer on the same request.
#Partner Identity
#GET /v1/partner/me
Returns the authenticated partner context, including the current client scope, data environment, and allowed integration capabilities.
#API Keys
API-key responses return safe metadata only, except create and rotate responses which reveal the generated secret once. Store that secret immediately; it cannot be retrieved later.
| Route | Purpose |
|---|---|
GET /v1/partner/api-keys | List API-key metadata for the scoped partner client |
POST /v1/partner/api-keys | Create a new API key and return the secret once |
POST /v1/partner/api-keys/{key_id}/rotate | Rotate an existing key and return the new secret once |
POST /v1/partner/api-keys/{key_id}/revoke | Revoke an existing key |
#Webhooks
Webhook routes are project scoped. Mutating requests require the current revision guard through the request body or If-Match header. Generated signing secrets are returned only when created or rotated.
| Route | Purpose |
|---|---|
GET /v1/partner/webhooks | List webhook endpoints for a project |
POST /v1/partner/webhooks | Create a webhook endpoint |
PATCH /v1/partner/webhooks/{webhook_id} | Update a webhook endpoint |
DELETE /v1/partner/webhooks/{webhook_id} | Delete a webhook endpoint |
POST /v1/partner/webhooks/{webhook_id}/rotate-secret | Rotate the endpoint signing secret |
POST /v1/partner/webhooks/{webhook_id}/test | Send a test delivery to the endpoint |
GET /v1/partner/webhooks/deliveries | List safe delivery metadata for troubleshooting |
Runtime and test deliveries include canonical signing headers such as X-AiDial-Delivery-Id, X-AiDial-Event, X-AiDial-Timestamp, X-AiDial-Endpoint-Id, and X-AiDial-Signature. Delivery history never returns raw payloads, transcripts, response bodies, signing secrets, bearer tokens, API keys, or ciphertext.
#Catalogs
| Route | Purpose |
|---|---|
GET /v1/catalogs/voices | List voices available to the authenticated partner scope |
GET /v1/catalogs/models | List models available to the authenticated partner scope |
#Capacity
Capacity routes return safe availability and history summaries for authorised partner and operator callers.
| Route | Purpose |
|---|---|
GET /v1/capacity/overview | Read current capacity posture |
GET /v1/capacity/history | Read recent capacity history |