Make an API key
A key lets your own code use Rykon AI with exactly the scopes you give it. It is shown once.
Updated 1 min read
Owners and admins can make keys.
- Step 1: Open API keys.
- Step 2: Under Make a key, name it after the system that will use it.
- Step 3: Tick its scopes, grouped by area, or start from a preset (Read only, Automation: start work, Connectors setup, Everything I hold). The count shows how many you chose. Give it the least that system needs; a key can hold only scopes you hold yourself.
- Step 4: Choose when it expires, or leave it to last until revoked.
- Step 5: Choose Make key, and copy the key that appears. It is shown once and can never be shown again.
Send it as a bearer token on every request:
curl https://api.rykon.ai/v1/runs \
-H "Authorization: Bearer $RYKON_AI_KEY"The API docs list every route and the scope it needs.
What a key cannot do
- Approve, edit or reject an action: a person decides those in the console.
- Reach another account.
- Hold more than the person who made it.