Ardela
Ardela
Help Centre
API

Authentication

Authenticate to the beta Ardela v1 API with workspace API keys.

All v1 endpoints require a workspace API key sent in the Authorization header.

Create an API key

  1. Sign in to Ardela as a workspace admin or owner
  2. Open Settings → API Keys
  3. Click New API key
  4. Enter a descriptive name, such as "CRM filing automation"
  5. Select the scopes your integration needs
  6. Copy the key immediately. It is shown only once.

Each workspace can create up to 25 API keys.

Using your API key

Include the key as a Bearer token on every request:

GET /api/v1/recordings HTTP/1.1
Host: app.ardela.ai
Authorization: Bearer ardela_pk_your_api_key_here
Accept: application/json

API keys use the prefix ardela_pk_.

Scopes

ScopeAllows
read:recordingsList and fetch recordings
write:recordingsMark recordings as filed (POST .../filings)
manage:webhooksCreate, list, delete webhooks; inspect and replay deliveries

Typical CRM filing integrations need read:recordings and write:recordings. Add manage:webhooks only if your integration manages webhook subscriptions via the API.

How keys are scoped

  • Keys belong to a workspace, not an individual user session
  • A valid, unrevoked key works regardless of the creator's current membership status
  • All data access is limited to that workspace
  • Revoke keys from Settings → API Keys when rotating or decommissioning integrations

Subscription and usage

  • The workspace must have an active Pro or Enterprise subscription to call v1 endpoints (Starter plans are not included)
  • Requests are also subject to the per-workspace rate limit

Security

  • Store keys in a secrets manager. Never commit them to git or embed them in frontend code.
  • Use separate keys for development and production
  • Rotate keys according to your organisation's credential policy and immediately if a key is exposed
  • Revoke unused keys promptly

On this page