Read an API key

GET /v1/api-keys/{key_id}

Answers one key of the Organization by its prefix, never the secret (1.51.0). A developer manages test keys only (access-control-and-isolation.md section 4.2), so its reads answer test keys only and a live key of the Organization is not_found to it. Session only (api.md section 2): the api refuses the route to every API key with forbidden, whatever its scopes; Phase 0 accepts a Member ID token.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the api_keys:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/api-keys/key_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/api-keys/key_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/api-keys/key_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is ApiKey.