Core

Ping

GET /ping checks a key and tells you its mode. Any valid key works.

{ "object": "ping", "ok": true, "livemode": false, "api_version": "2026-10-01" }

Me

GET /me returns the key's id, scopes and organisation.

{
  "object": "api_key",
  "id": "key_…",
  "livemode": false,
  "scopes": ["interviewers:read", "invitations:send", "results:read"],
  "organisation": { "name": "Acme", "slug": "acme" },
  "api_version": "2026-10-01"
}

Usage

GET /usage needs billing:read. It returns your credit balance and the most recent credit movements: grant entries add credits, session entries use one.

{
  "object": "usage",
  "credits": { "free": 10, "granted": 100, "total": 110, "used": 42, "remaining": 68 },
  "ledger": {
    "object": "list",
    "data": [
      { "type": "session", "credits": -1, "note": null, "session_id": "ses_…", "created_at": "2026-10-01T09:30:00.000Z" }
    ],
    "has_more": false,
    "next_cursor": null
  }
}

Test-mode sessions never appear in the ledger.