Skip to navigation

Get current API key

Returns the API key used for the request: its environment, scopes, pinned API version, expiry, IP allow-list, organization and request limits. Use it to check a key before going live, or to show which organization an integration is connected to. The secret part of the key is never returned. Any valid API key can call this operation, whatever its scopes. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"api_key"

Always api_key.

idstringformat: "uuid"

Id of the key. It is not the secret: it identifies the key in the app and in the audit log.

prefixstring

Visible prefix of the key, for example vx_live_ab3k7x2q: the part shown in the app to recognize it. The rest of the key is never returned.

namestring
The name given to the key when it was created.
environmentenum

live: real calls, real data, usage is billed. test (vx_test_ keys): reads return the real data of the organization, writes are simulated and nothing is billed.

Allowed values:
scopeslist of enums

What the key may do. Each operation states the scope it requires; a missing scope gives 403 insufficient_scope.

api_versionstring

The API version this key is pinned to, as a date (YYYY-MM-DD). A request can ask for another one with the VoxAI-Version header.

expires_atdatetime

When the key stops working, ISO 8601 UTC. After that every request gives 401 invalid_api_key.

allowed_ipslist of strings
IP addresses or ranges the key can be used from. Empty means every address is allowed.
organizationobject

The organization the key belongs to: every operation reads and writes only its data.

rate_limitsobject

Request limits now in force. Over a limit the response is 429 rate_limited with a Retry-After header.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error