Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json
name
string
required

Human label to identify the key later (e.g. "Production backend").

scopes
enum<string>[]
required

The permissions this key grants — keep it to the narrowest set the integration needs.

Frozen scope strings.

Available options:
agents:read,
agents:write,
knowledge:read,
knowledge:write,
skills:read,
skills:write,
playbooks:read,
playbooks:write,
guardrails:read,
guardrails:write,
numbers:read,
numbers:write,
sms:read,
sms:write,
outbound:read,
outbound:write,
integrations:read,
integrations:write,
integrations:connect,
calls:read,
billing:read,
billing:write,
analytics:read,
analytics:write,
audit:read,
webhooks:write,
keys:write,
chat:read,
chat:write,
chat:public,
widgets:read,
widgets:write,
pubkeys:read,
pubkeys:write,
phone:read,
phone:write,
presence:write,
team:read,
team:write,
escalation_destinations:read,
escalation_destinations:write,
escalation_policies:read,
escalation_policies:write,
escalations:read,
escalations:claim,
escalations:respond,
escalations:resolve
env
enum<string>
required

live for real production traffic, test for a sandbox key that never touches billable resources.

Available options:
live,
test
expiresAt
string<date-time>

Optional expiry (RFC3339). After this time the key stops authenticating. Omit for a non-expiring key.

Response

Created key (token shown once).

success
boolean
required
data
object
required
message
string
errors
object[]