API Keys

Get an API key

Returns one key, including a revoked one. The token is in the response while the key is active, except to an assistant connection without write access, which gets only token_hint and a 403 for reveal=true. Pass reveal=true to record the read in the key's audit trail as a revealed event; use it when a person or tool is deliberately showing the token. A revoked key has no token and records no event.

get/api_keys/{id}

Request

  • Base URL: https://alttext.ai/api/v1
  • URL: https://alttext.ai/api/v1/api_keys/{id}
  • Auth: API key in header X-API-Key

Path parameters

idinteger required

The ID of the key.

Query parameters

revealboolean

true records a revealed event for an active key.

detail'full'

full adds a usage object, the same report the dashboard shows.

Response

The key. With detail=full it also has usage.

OR

Changes

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