Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
name
string
required
Maximum string length: 100
scopes
string[]

Must be a subset of the calling credential's own scopes — a key can never mint another key with broader access than itself. Omitted defaults to the calling credential's own scopes (or, if the credential itself has unrestricted access, every scope).

Maximum array length: 50
expires_in_days
integer

Requested lifetime. Omitted inherits a finite calling credential's expiry, or means no expiry when the caller itself does not expire.

Required range: 1 <= x <= 365

Response

The minted key (shown once).

data
object
required

A newly-minted API key, including the plaintext secret.