API reference
Create a key for one workspace or the whole organization, and revoke it at once.
Keys are made in your own name, scoped to a workspace or to every workspace, and shown once.
Scope
- Workspace key
- Reaches one workspace. It can only make keys for that same workspace.
- Organization key
- Reaches every workspace its maker can open, and its row in the list says so. Only an owner or an admin can make one.
Creating one
Open API Key in the console's rail, or call the endpoint from your server. The secret is shown once, when the key is made; store it in your secret manager then, because it cannot be read again.
POST /v1/orgs/{org}/keys {"name": "Production server", "workspace": "<workspace id>"}
GET /v1/orgs/{org}/keys name, last four characters, when it was made and last used
PATCH /v1/orgs/{org}/keys/{id} {"name": "..."} rename; a name is cut to 120 characters
DELETE /v1/orgs/{org}/keys/{id} revokeWho can do what
- A person makes keys in their own name only.
- A key can be revoked by the person who made it, by the key itself, or by an owner or an admin. An AI member's key cannot revoke one.
- A revoked key stops working at once. Revoking cannot be undone.
- AuthenticationSending the key, from your server only.
- Discovery and versionsAsk which organization, workspace and member a key acts as.
Ready to run this against a live workspace?Create API key