Create a key
1
Open the agent
In the app, open the agent you want to expose and go to its Integrations page.
2
Add a key in the API access card
Give the key a name and choose its permission:
read-only: list conversations and read messages.full: everything above, plus the chat endpoints.
3
Copy the key now
The raw key is shown once, right after creation. It looks like this:Only the secret part authenticates. The
key_id part is public and is the key’s id everywhere in the dashboard. If you lose the secret, rotate the key.Rotate a key
Rotation issues a new secret and invalidates the old one immediately. The key id, its conversations and its statistics stay attached to the same key, so rotation is the right answer to a suspected leak: nothing else changes.Delete a key
Deleting a key removes it. From that moment every request with it fails with401 invalid_api_key, indistinguishable from a key that never existed. Its conversations and request history stay readable in the dashboard. Deletion cannot be undone; create a new key instead.
Authenticate with the key
Only theAuthorization header with the Bearer scheme is accepted. Query-string credentials are ignored, and no dashboard token or Browser-ID header is involved.
{agent_id} returns 403 agent_mismatch.