Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

A name for the key. 120 characters at most.

scopes
enum<string>[]

The scopes the key holds.

Available options:
tenants:write,
channels:read,
channels:write,
messages:read,
messages:write,
assistants:read,
assistants:write,
knowledge:read,
knowledge:write,
leads:read,
leads:write,
tools:write,
webhooks:read,
webhooks:manage,
usage:read
expires_at
string<date-time>

An optional expiry time, ISO 8601.

Response

Success