Skip to navigation
API ReferencePlatformAPI Keys

Create API Key

Create a new API key for authenticating API requests.

API keys provide a simpler alternative to OAuth for programmatic access. Each key:

  • Is tied to the creating user and inherits their permissions
  • Can be used to authenticate requests to any project endpoint
  • Has a descriptive name for easy management
  • Can be revoked at any time

The API key is only shown once at creation time and cannot be retrieved later.

Security Notes:

  • Store API keys securely (use environment variables, not hardcode)
  • Rotate keys regularly
  • Each key inherits the user’s project permissions
  • Revoke compromised keys immediately

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The unique identifier of the organization.
project_idstringRequiredformat: "uuid"
The unique identifier of the project.

Request

This endpoint expects an object.
namestringRequired

Response

API key created successfully
namestring
idstringformat: "uuid"
keystring
oauth_client_idstringformat: "uuid"
createddatetime
expires_atdatetime
revokedboolean
last_useddatetime or nullOptional

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error