AIXBT Docs
API v3Reference

Get the calling credential's capabilities

GET
/v3/me

Everything an integration needs to plan requests: credential metadata, entitlements, effective rate limits, and the history window. Replaces /v2/api-keys/info.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/me"
{
  "data": {
    "credential": {
      "id": "key_01",
      "name": "prod-bot",
      "type": "full",
      "expiresAt": null
    },
    "entitlements": [
      "api",
      "topic-reports"
    ],
    "rateLimit": {
      "perMinute": 30,
      "perDay": 10000
    },
    "history": {
      "archiveAccess": false,
      "enforced": true,
      "lookbackDays": 90,
      "earliestAvailableAt": "2026-05-07T00:00:00Z",
      "enforcementAt": "2026-08-17T00:00:00Z"
    }
  },
  "meta": {}
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 30,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}

Get the filter vocabularies GET

One discovery surface for every value a v3 filter accepts. Closed vocabularies (grades, sentiments, stances, sort keys, activity modes, rankings, universes, asset types, series measures) are versioned with the contract; catalog-derived sets (project categories, intel categories, chains) are composed from their owning catalogs at read time and carry their own versions.

Get this contract GET

The canonical v3 OpenAPI document, served verbatim. No credential required.