Sign in

v1

latestOpenAPI 3.1.02026-07-2219165126.1 KB
API Keys

Create an API key

Create a new API key for the authenticated account and return the plaintext key once.

post/v1/account/keys

Request body

namestring required

Name for the API key

credit_limitnumber nullable

Optional credit limit for the API key

expires_atstring date-time nullable

Optional expiration datetime for the API key. Must be in the future.

Example request

{
  "credit_limit": 25,
  "expires_at": "2026-12-31T23:59:59Z",
  "name": "CI worker"
}

Response

API key created successfully.

idinteger required
namestring required
keystring required
created_atstring date-time required
expires_atstring date-time nullable required
is_enabledboolean required
credit_limitnumber nullable required
messagestring

Example response

{
  "created_at": "2026-03-31T10:00:00Z",
  "credit_limit": 25,
  "expires_at": "2026-12-31T23:59:59Z",
  "id": 18,
  "is_enabled": true,
  "key": "ng-1234567890abcdefghijklmnopqrstuv",
  "message": "Store this key securely. It will not be shown again.",
  "name": "CI worker"
}