latestOpenAPI 3.1.02026-08-149289225.1 KB

664536fccd0e

API keys

Create an API key

post/api/v0beta1/api-keys

Request body

namestring required

Human-readable name for the API key.

scope'organization' | 'user'

Scope of the key to create. Defaults to organization; pass user to mint a key owned by the calling user.

Example request

{
  "scope": "organization"
}

Response

Created API key, including its plaintext value.

idstring required
namestring required
scope'organization' | 'user' required

Whether the key is scoped to the caller's organization or to the individual user who owns it.

obfuscatedValuestring required
lastUsedAtstring nullable required
createdAtstring required
updatedAtstring required
valuestring required

Example response

{
  "scope": "organization"
}