Validate the key and discover capabilities
Returns the workspace, the key used for this request, the plan limits in force, and the current billing period. Make this the first call of any integration: it tells you which scopes you hold and how much allowance remains before you spend any of it.
anybilling unitfreeagent notesFree and safe to call repeatedly. Use `plan.limits.rpm` and `concurrency` to pace requests and `period.used` versus `period.included` to decide whether a bulk run fits the remaining allowance. A 401 here means the key is wrong or revoked, not that the service is down.
Returns the workspace, the key used for this request, the plan limits in force, and the current billing period. Make this the first call of any integration: it tells you which scopes you hold and how much allowance remains before you spend any of it.
Authorization
ApiKey Workspace API key as a bearer token. Create keys in the dashboard under Settings → API keys. Test keys (oai_test_) answer from a fixed test tenant and never queue production scans.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/account"{ "key": { "environment": "live", "expires_at": null, "id": "key_01J9X4K6ZP3M8Q2R5T7V9W1Y3A", "label": "Clay production", "prefix": "oai_live_a1b2", "scopes": [ "read:stores", "read:signals" ] }, "period": { "ends_at": "2026-10-01T00:00:00Z", "included": { "history_query": 10000, "lookup_cached": 10000, "lookup_live": 500, "refresh_requested": 0 }, "starts_at": "2026-09-01T00:00:00Z", "used": { "history_query": 88, "lookup_cached": 1234, "lookup_live": 7, "refresh_requested": 0 } }, "plan": { "limits": { "concurrency": 10, "enrich_batch_max": 100, "freshness_days": 30, "history_days": 365, "live_refreshes_per_period": 500, "rpm": 300 }, "slug": "growth" }, "workspace": { "id": "ws_01J9X4K6ZP3M8Q2R5T7V9W1Y3A", "name": "Acme Agency" }}