API
REST API
Integrate Ardela recordings with Clio, Zapier, and other systems using the v1 API.
The Ardela v1 REST API lets you read completed recordings, fetch transcripts and generated notes, mark recordings as filed in external systems, and receive webhook notifications.
Base URL
https://api.ardela.ai/api/v1All requests use HTTPS. JSON request and response bodies unless noted otherwise.
Quick start
- Create an API key in Settings → API Keys (workspace admin)
- Authenticate with
Authorization: Bearer ardela_pk_... - Poll
GET /recordings?status=COMPLETED&syncState=unsyncedfor new work - Fetch full content with
GET /recordings/:id - After filing in your CRM, call
POST /recordings/:id/filings
See Authentication and Integrations for a full walkthrough.
Endpoints
| Method | Path | Scope | Description |
|---|---|---|---|
GET | /recordings | read:recordings | List recordings (poll for unsynced) |
GET | /recordings/:id | read:recordings | Full recording with transcript and content |
POST | /recordings/:id/filings | write:recordings | Mark recording filed in external system |
GET | /webhooks | manage:webhooks | List webhook subscriptions |
POST | /webhooks | manage:webhooks | Create webhook subscription |
DELETE | /webhooks/:id | manage:webhooks | Delete subscription |
GET | /webhooks/deliveries | manage:webhooks | Inspect delivery attempts |
POST | /webhooks/deliveries/:id/replay | manage:webhooks | Retry a failed delivery |
Guides
Authentication
API keys, scopes, and workspace requirements
Recordings
List, fetch, and mark filed
Webhooks
Signed recording.completed events
Integrations
Zapier and CRM filing patterns
Errors & limits
Rate limits, errors, best practices
Requirements
- Active subscription — expired workspaces cannot use the API
- API key scopes — each endpoint requires the matching scope
- Monthly API quota — plan-based request limits apply per workspace
- HTTPS only — never expose API keys in client-side code
Versioning
Current version: v1. Breaking changes will ship as v2 with a 12-month support window for v1.
Related
- Create keys in the app: Settings → API Keys
- FAQ → API questions
