anek_org_. A key belongs to one organization and reaches only that organization’s data: its projects, agents, and calls on the Voice API, and its tickets, customers, and settings on the Support API. The same key works on both.
Getting a key
API keys are issued by Clarity. Ask your Clarity contact, or email hello@onclarity.com, and say what the key is for. Each key gets its own label, so one integration’s key can be revoked or replaced without touching the others.What a key can do
A key acts for the organization as a whole, with the access of a business user. It can read and change configuration, publish voice agents, and place calls. A few actions need a signed-in person in the Clarity app and refuse an API key, with a403:
- Listening to, joining, steering, or hanging up a live call.
- Claiming calls as a Voice Assist operator.
- Creating or revoking API keys.
Expiry, rotation, and revocation
Keeping keys safe
- Keep keys on your servers. Never ship one in a web page, a mobile app, or source control. The chat widget and the mobile SDKs use their own public identifiers instead (see SDKs).
- Give each integration its own key, so you can revoke one without breaking the rest.
- If a key leaks, contact Clarity to revoke it at once.
Errors
See Errors for the full list.