Skip to main content
POST
/
api
/
v1
/
api-keys
Create API Key
curl --request POST \
  --url https://api.example.com/api/v1/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    {}
  ]
}
'
{
  "id": "...",
  "name": "Production Backend",
  "key": "org_live_abc123xyz...",
  "scopes": ["usage.write"],
  "status": "ACTIVE",
  "created_at": "2025-01-01T00:00:00Z"
}
name
string
required
Descriptive name for this key
scopes
array
required
List of scopes: usage.write, usage.read
The key secret is returned only once in the response. Store it securely.
{
  "id": "...",
  "name": "Production Backend",
  "key": "org_live_abc123xyz...",
  "scopes": ["usage.write"],
  "status": "ACTIVE",
  "created_at": "2025-01-01T00:00:00Z"
}