API reference · Schema
ApiKey
objectstringrequiredAlways `api_key`: the type of this object
One of
api_keyidstringrequiredUnique ID (`key_…`)
ID with prefix key_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
project_idstringrequiredProject it belongs to
ID with prefix prj_
namestringrequiredIts name
scopesarray of stringrequiredActions (`resource:verb` or `resource:*`) the key may perform, as granted
last4stringrequiredLast four characters of the secret, for display
statusstringrequired`active`: usable; `revoked`: revoked and refused from then on; `expired`: past `expires_at` and refused
One of
activerevokedexpiredexpires_atstring (date-time) | nullrequiredWhen it expires (null: never) (ISO 8601, UTC)
last_used_atstring (date-time) | nullrequiredUpdated at most once a minute
revoked_atstring (date-time) | nullrequiredWhen it was revoked (null while it is valid) (ISO 8601, UTC)
created_by_user_idstring | nullrequiredID of the user who created it
created_byobject | nullrequiredWho created it (null: created by the platform)
ShowHide 3 fields of
created_byobjectstringrequiredAlways `person`
One of
personidstringrequiredThe person’s user ID (`usr_…`)
namestring | nullrequiredTheir name as they set it; null when they are no longer a member of the organization
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
{
"object": "api_key",
"id": "key_01jc5zq4m8k3v6x9t2w7r0b1e4",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
"name": "string",
"scopes": [
"ssh_key:read",
"inference:invoke"
],
"last4": "string",
"status": "active",
"expires_at": "2026-01-01T00:00:00.000Z",
"last_used_at": "2026-01-01T00:00:00.000Z",
"revoked_at": "2026-01-01T00:00:00.000Z",
"created_by_user_id": "string",
"created_by": {
"object": "person",
"id": "string",
"name": "string"
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Used by
- List API keys in the project
GET /v1/api-keys - Get an API key
GET /v1/api-keys/{api_key_id} - Rename an API key
PATCH /v1/api-keys/{api_key_id} - Revoke an API key (takes effect immediately; idempotent)
POST /v1/api-keys/{api_key_id}/revoke