Skip to content
Zaraftis API
Esc
↑↓navigate↵open⌘Jpreview

List platforms, prices, and limits

Returns the AI platforms a scan can use, the credit price of each paid operation, and the request limits. Read it before you build a scan request.

GET/capabilities
Authorization
AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Responses
200

Supported platforms, the credit catalog, and limits

successbooleanrequired
dataCapabilitiesObjectrequired
Show properties
capabilities_schema_versionintegerrequired
min -9007199254740991 · max 9007199254740991
matrix_versionstringrequired
min length 1
workspace_organization_idstringrequired
min length 1
platformsobject[]required
Show properties
Array of object
platform_idstringrequired
min length 1
statusstringrequired
capability_versionstringrequired
min length 1
countriesstring[]required
languagesstring[]required
operationsobject[]required
Show properties
Array of object
namestringrequired
min length 1
unit_creditsintegerrequired
min 0 · max 9007199254740991
notesstringrequired
min length 1
limitsobjectrequired
Show properties
max_prompts_per_scanintegerrequired
min 1 · max 9007199254740991
max_queries_per_scanintegerrequired
min 1 · max 9007199254740991
max_tracked_competitors_per_comparisonintegerrequired
min 0 · max 9007199254740991
checks_sync_deadline_secondsintegerrequired
min 1 · max 9007199254740991
concurrent_workobjectrequired
Show properties
scansintegerrequired
min 1 · max 9007199254740991
active_queriesintegerrequired
min 1 · max 9007199254740991
notestringrequired
min length 1
request_idstringrequired
min length 1
Request
curl -X GET 'https://api.zaraftis.com/v1/capabilities' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "data": {
    "capabilities_schema_version": -9007199254740991,
    "matrix_version": "string",
    "workspace_organization_id": "string",
    "platforms": [
      {
        "platform_id": "string",
        "status": "available",
        "capability_version": "string",
        "countries": [
          "string"
        ],
        "languages": [
          "string"
        ]
      }
    ],
    "operations": [
      {
        "name": "string",
        "unit_credits": 0,
        "notes": "string"
      }
    ],
    "limits": {
      "max_prompts_per_scan": 1,
      "max_queries_per_scan": 1,
      "max_tracked_competitors_per_comparison": 0,
      "checks_sync_deadline_seconds": 1,
      "concurrent_work": {
        "scans": 1,
        "active_queries": 1
      },
      "note": "string"
    }
  },
  "request_id": "string"
}

Was this page helpful?