REST API
Build custom integrations with Ardela recordings using the beta v1 API.
The Ardela v1 REST API lets you read completed recordings, fetch transcripts and generated content, mark recordings as filed in external systems, and receive webhook notifications.
The API is currently in pre-launch beta. It requires a Pro or Enterprise plan with API access enabled. Starter plans do not include API requests, and beta access may need to be enabled for your workspace.
Base URL
https://app.ardela.ai/api/v1All requests use HTTPS. Requests and responses use JSON 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
Custom automation and CRM filing patterns
Errors & limits
Rate limits, errors, best practices
Requirements
- Pro or Enterprise plan: Starter plans cannot use the API
- Active subscription: expired workspaces cannot use the API
- API key scopes: each endpoint requires the matching scope
- HTTPS only: never expose API keys in client-side code
Integration availability
The API supports developer-built integrations and the available API-key connection for Zapier. Open Settings → Integrations for the guided Zapier setup.
Clio Manage can be connected from Settings → Integrations for client and matter import. The v1 API remains the path for custom recording-filing workflows, including filing completed Ardela content into Clio or another external system. See Integrations for the pattern.
Versioning
Current version: v1 beta. The contract may change before general availability. Review these docs when updating an integration and test changes in a non-production workflow first.
Related
- Create keys in the app: Settings → API Keys
- Billing & plans
- FAQ → API questions