API keys

Mint an API key

Mint a developer API key for the caller's own tenant. The plaintext key is returned in this response. Workspace owners and admins can recover eligible keys in the dashboard; recovery is not available through the developer API.

Requires an API key with the api_keys:write scope.

post/v1/api-keys

Request

  • Base URL: https://realtimeavatar.ai/api
  • URL: https://realtimeavatar.ai/api/v1/api-keys
  • Auth: HTTP bearer

Request body

namestring required
environment'live' | 'test'

Deprecated. Accepted for older clients but ignored; all new keys use the same tic_ format.

scopesstring[]
spendLimitCreditMicrosinteger nullable
expiresAtstring date-time nullable

Response

Created. The plaintext key is returned on creation; workspace owners and admins can recover eligible keys in the dashboard. Recovery is not available through the developer API.

idstring required
keyIdstring required
tenantIdstring required
namestring required
redactedKeystring required
canRevealboolean required
scopesstring[] required
status'active' | 'revoked' | 'expired' required
spendLimitCreditMicrosinteger nullable required
createdAtstring required
expiresAtstring nullable required
apiKeystring starts_with required

Changes

No recorded changes to this operation across all 2 revisions of this API.