API keys
Create an API key to connect Zapier, Make or a script to Caryon Lead without sharing your password.
An API key connects Zapier, Make or a script to Caryon Lead without sharing your password. It acts on your behalf, with your rights.
Plan
API keys are included in the Business and Enterprise plans, and during the trial. On Starter, they are refused.
Create a key
Open your connections
In Caryon ID, open « Connexions » (Connections), the « Clés API » (API keys) card, then click « Créer une clé » (Create a key).
Fill in the form
- Nom (Name): the tool that will use it (for example "Zapier"). One key per tool.
- Espace (Workspace): a key only works for one workspace. A workspace that is not eligible is greyed out with its reason.
- Rôle (Role): « Mon rôle » (My role) or a role with fewer rights than yours. Never more. With « Mon rôle », an owner's or an admin's key acts as they do, for instance to change another member's action; with another role, never.
- Lecture seule (Read-only): the key can read, without changing anything.
- Durée (Lifetime): 30 days, 90 days (default), 1 year or no expiry.
Copy the key
It starts with cyk_ and is shown only once. Click « Copier la clé » (Copy the key) and store it in your tool. If you lose it, revoke it and create another.
Use the key
Send it in the header of every call:
Authorization: Bearer cyk_…See the API reference. The same key also works with the AI agents server.
Limit: 30 calls per minute and 5,000 per day per key.
Follow, renew, revoke
- Each key shows its workspace, role, expiry and last use. A key past its date is marked « Expirée » (Expired) and stays listed so you can remove it.
- Seven days before expiry, you get the notification "Votre clé API « Zapier » expire le …" (Your API key "Zapier" expires on …). Create a new one so your tools keep working.
- « Révoquer » (Revoke) refuses the key immediately (« Annuler » stays available for 5 seconds).
- When a member leaves or is removed from the workspace, their keys are revoked.
For owners and admins
In Caryon ID, open the workspace, then « API et agents IA » (API and AI agents):
- two switches, on by default: « Clés API » and « Agents IA ». When off, a switch makes existing keys (or agents) refused without revoking them;
- the list of every member's keys and agents, which you can revoke.
What keys write can be found in the Change log.
Good practice
- Treat a key like a password: never in a message, a shared document or a code repository.
- Prefer « Lecture seule » when the tool only needs to read.
- Choose a short lifetime, and one key per tool.
A question not answered here? Write to us at contact@caryon.app.