Create Api Key V1

Create a new API key for the calling tenant. Requires the admin scope on the calling key — non-admin keys can only read and use keys, not mint new ones…

POST /api/v1/keys

cURL

curl --request POST \
  --url 'https://api.computer.stateset.app/api/v1/keys' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Two-Person Tent",
  "scopes": [
    "string"
  ],
  "rate_limit_per_minute": 60
}'

201

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "key": "string",
  "key_prefix": "string",
  "scopes": [
    "string"
  ],
  "rate_limit_per_minute": 8,
  "created_at": "2026-08-31T14:22:05Z"
}

Create a new API key for the calling tenant.

Requires the admin scope on the calling key — non-admin keys can only read and use keys, not mint new ones. The plaintext is returned once in this response and never again; lose it and the only path forward is to delete and re-create.

Request body

CreateAPIKeyRequest

name · string · required

Human-readable label, e.g. ‘CI bot’ or ‘Slack integration’.

scopes · string[]

Allowed scopes. Empty list = full-access (back-compat). Otherwise must be a subset of: trigger:write, jobs:read, jobs:write, admin.

rate_limit_per_minute · integer

Per-key request budget. Range 1..10000.

Response

CreateAPIKeyResponse

id · string · required

name · string · required

key · string · required

Plaintext API key — store it now. The platform only retains the SHA-256 hash; this is the one and only time the secret is exposed.

key_prefix · string · required

scopes · string[] · required

rate_limit_per_minute · integer · required

created_at · string · required

Status codes

Code	Meaning
201	Successful Response
422	Validation Error

cURL

curl --request POST \
  --url 'https://api.computer.stateset.app/api/v1/keys' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Two-Person Tent",
  "scopes": [
    "string"
  ],
  "rate_limit_per_minute": 60
}'

201

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "key": "string",
  "key_prefix": "string",
  "scopes": [
    "string"
  ],
  "rate_limit_per_minute": 8,
  "created_at": "2026-08-31T14:22:05Z"
}