Settings

API Keys

Authenticate the CLI, the REST API, and your own backend against your workspace.


Creating a key

Go to Settings โ†’ API Keys and click Create Key. The secret is shown once โ€” store it in your own secret manager immediately.

Using a key

bash
curl https://api.katexs.com/v1/agents \
  -H "Authorization: Bearer $KATEXS_API_KEY"

Scopes

ScopeGrants
agents:readList and read agent configuration
agents:writeCreate, update, and deploy agents
calls:readRead call logs and transcripts
calls:writeCreate outbound calls and campaign dispatch calls
phone_numbers:readList phone numbers and inspect provisioning state
phone_numbers:writeProvision numbers and assign to agents
campaigns:readList campaigns, targets, and campaign calls
campaigns:writeCreate/update campaigns, targets, and dispatch
analytics:readRead usage and API traffic analytics
*Admin wildcard scope for all API routes

Rotation

Rotate keys any time. Old keys keep working for 24 hours after rotation so deployments can catch up.