API keys and permissions

Create keys with full access, or limit a key to exactly the endpoints an integration needs.

API keys authenticate the public API. Every key belongs to your workspace and acts on its data.

Full access or custom

  • Full access — the key can call every public endpoint.
  • Custom — the key can call only the permissions you tick.

Give every integration its own key, with only what it needs. A key that can only read call history cannot place calls if it leaks, and revoking it breaks one integration rather than all of them.

Permissions

AreaPermissions
Call jobslist, read details, read rows, create, update, delete
Historyread call history, chat history, chat sessions, generated calls
Outboundtrigger calls, trigger chats
Live injectionsinject into calls, inject into chats
Flowsread, read details, create, update, delete
Agentsread agents; read and write agent knowledge bases
Toolsread, create, update, delete
Structured outputsread, create, update, delete
Phone numbersread, create, update, delete
Applications and data storesread applications; read and write data stores
Accountread balance
Reports and artifactsread tool usage reports, read automation artifacts
Testingcall the test endpoints

Keys are production credentials

Keep keys in a secret store, never in browser or mobile code, and revoke any key that has been pasted somewhere shared.

See also Rate limits.