API keys
Where to find your API key and ingest key, and how to create, replace and keep them safe
Zime gives your company two keys, found in one place. The API key lets your own tools read your calls, transcripts and insights. The ingest key lets your own tools send calls into Zime. This page shows where to find them, how to create and replace them, and how to keep them safe.
The two keys
Each key does one job, and neither can do the other's.
Keep them apart in your tools. Anyone holding a key can use it, so treat each one like a password.
| Key | What it does | Good to know |
|---|---|---|
API key | Pulls your calls, call transcripts and call insights (summary, important points and action items) over HTTPS. | The API is free and uses no credits. |
Ingest key (write) | Sends calls into Zime from your own dialer, meeting tool or call export. | It can only send calls in. It cannot read any data. |
The API reference, with the addresses, date ranges and examples, is at zime.ai/developers/api-reference. Sending calls with the ingest key is covered in Call Ingest API.
Create and copy a key
Only company admins can create, show or replace the keys.
Other people who open the page see a note asking them to contact an admin. The ingest key card is shown to admins only.
Open the APIs tab
In Zime, go to Admin, then APIs.
Generate the key
Press Generate key on the card you need, then confirm.
Copy it
Press Show key, or press Copy to copy it without showing it. The key hides again after a minute. You can show it again whenever you need it.
Store it safely
Put it in your secret store. Do not send it by email or chat in plain text.
Replace or revoke a key
Generate a new key if the current one was shared or lost.
A new key takes over immediately and the old one stops working. Update every script, warehouse job and integration with the new key before you close the confirmation screen.
If you revoke the API key, your company has no working API key until you generate another. If you revoke the ingest key, your company cannot send calls into Zime until you generate another.
Each card keeps a history. Press See history to see who generated, showed or revoked the key, and when. The card also shows the last four characters of the key and who created it.
Questions
Who can see the keys?
Company admins. Everyone else is asked to contact an admin.
Does using the API cost credits?
No. The API is free and uses no credits.
Can the ingest key read my data?
No. It can only send calls into Zime, and it is separate from the API key.
My calls are rejected even with a valid ingest key. Why?
Zime has to enable your call source before the first call is accepted. See Call Ingest API or email support@zime.ai.
The ingest key card says it is not available yet.
Nothing is needed from you. The card will work once it is ready.
Still need help?
Write to support@zime.ai and the team will get back to you.