Check a key

GET/v1/pingNeeds an API key

Confirm the presented key authenticates and report the organisation it acts for.

Response

The key is valid. The workspace it acts for. The workspace the presented key acts for.

organization_idstring

The ID of the workspace the key acts for. The API calls it an organization.

400Refused request body

The request was refused.

401INVALID_AUTH_TOKENRefused request body

The API key is missing, wrong or revoked.

422VALIDATIONInvalid request body

The request is not valid.

429RATE_LIMITEDRefused request body

Too many requests with this API key.

Retry-After: Seconds until the limit resets.

curl https://api.voxoria.ai/v1/ping \
  -H "Authorization: Bearer $VOXORIA_API_KEY"

import os

import httpx

response = httpx.get(
    "https://api.voxoria.ai/v1/ping",
    headers={"Authorization": f"Bearer {os.environ['VOXORIA_API_KEY']}"},
)
print(response.json())

const response = await fetch("https://api.voxoria.ai/v1/ping", {
  headers: {
    Authorization: `Bearer ${process.env.VOXORIA_API_KEY}`,
  },
});
console.log(await response.json());

200 OKResponseapplication/json

{
  "organization_id": "org_3nV7qL2xT9mK4pR8wY6cZb"
}