Capabilities

Discover operations, schemas and permissions

GET/capabilities

ScopeAny valid keyRoleCurrent memberBillingFree

The executable catalog. Every operation has a name, description, category, JSON input schema, required scopes, a read-only flag, and whether it is available in this environment and authorised for the calling key. The catalog is an explicit allowlist; adding an internal tool never publishes it. Also returns the projected data resources and the assistant guidance clients should load before answering product questions.

Response

200 · application/json

assistantGuidancestring

productGuideobject

operationsOperation[]

resourcesResource[]

curl --fail-with-body "https://app.ghostgtm.ai/api/v1/capabilities" \
  -H "Authorization: Bearer $GHOST_API_KEY"

Response200

{
  "assistantGuidance": "…",
  "productGuide": {
    "icps": {}
  },
  "operations": [
    {
      "name": "graph.filter_accounts",
      "description": "Deterministic account filter returning a 30-minute scoped handle.",
      "category": "graph",
      "requiredScopes": [
        "graph:read"
      ],
      "conditionalScopes": null,
      "adminOnly": false,
      "readOnly": true,
      "available": true,
      "authorized": true,
      "inputSchema": {
        "type": "object"
      }
    }
  ],
  "resources": [
    {
      "name": "accounts",
      "requiredScope": "graph:read",
      "collectionPath": "/api/v1/data/accounts",
      "recordPath": "/api/v1/data/accounts/{id}",
      "entityFilter": false,
      "columns": [
        "id",
        "name",
        "slug",
        "…"
      ],
      "accountFilter": true,
      "userBound": false
    }
  ]
}

Try itGET /capabilities

API key

Sends to app.ghostgtm.ai/api/v1 · free