Keys

Create an API key

Returns the plaintext key ONCE. Granting management scopes requires an owner session or a key that already holds them. A key cannot create a key in a project whose tool bundles run with full access (403) — its tools would run without approval; an owner or admin in the console can. Requires keys:write.

post/client/keys

Request

  • Base URL: https://api.roar-ai.com
  • URL: https://api.roar-ai.com/client/keys
  • Auth: HTTP bearer

Request body

namestring
projectIdstring uuid nullable
scopesstring[]
expiresInDaysinteger
spendLimitUsdnumber nullable
budgetPeriod'day' | 'week' | 'month' | 'total'

Response

The created key (plaintext shown once)

idstring uuid required
namestring nullable required
prefixstring required

The visible head of the key — enough to identify it, never enough to use it

projectIdstring uuid nullable required
scopesstring[] required
expiresAtstring date-time nullable required
createdAtstring date-time required
keystring required

Plaintext — shown once

baseUrlstring required

The OpenAI-compatible endpoint this key is used against

warningstring required

Changes

No recorded changes to this operation across all 1 revision of this API.