Skip to content
TrakkrLearnAPI
Sign in

AI Pages

Get AI Pages status, configuration, and usage stats for your brand's AI crawler optimization.

Code example

Get AI Pages Status
curl -X GET 'https://api.trakkr.ai/ai-pages?brand_id=00000000-0000-4000-8000-81f286d10c3c' \
  -H "Authorization: Bearer $TRAKKR_API_KEY"
Response · 200 OK
{
  "brand": {
    "id": "00000000-0000-4000-8000-81f286d10c3c",
    "name": "Notion",
    "website": "https://notion.so"
  },
  "config": {
    "enabled": true,
    "domain": "notion.so",
    "platform": "cloudflare",
    "features": [
      "structureddatainjection",
      "keyfactsextraction",
      "automatedfaqgeneration",
      "aisummaryblock"
    ],
    "crawlers": [
      "gptbot",
      "claudebot",
      "perplexitybot",
      "googleother"
    ]
  },
  "usage": {
    "requests_this_month": 4280,
    "requests_limit": 10000,
    "percentage_used": 42.8,
    "reset_date": "2026-04-01T00:00:00+00:00"
  }
}

Synthetic example. Values are made up.

API key required

60 req/min

Overview

The AI Pages endpoint (/ai-pages) returns the status, configuration, and usage stats for your brand's AI crawler optimization. AI Pages intercepts requests from AI crawlers (GPTBot, ClaudeBot, PerplexityBot) and serves optimized, AI-friendly versions of your pages.

What you get

  • - Whether AI Pages is enabled and which domain is configured
  • - Integration platform (Cloudflare, Vercel, Netlify, etc.)
  • - Active optimization features and enabled crawlers
  • - Monthly request usage vs. plan limits
If AI Pages has not been set up for this brand, both config and usage will be null. Open AI Pages to set it up.

Get Status

GET/ai-pagesReturns AI Pages configuration and usage for a brand.

Authenticate with Authorization: Bearer $TRAKKR_API_KEY. Key and access guide

Request parameters

brand_idstringqueryRequired

Brand UUID

Format: uuid

Responses and errors
200Successful Response

application/json

brandobjectRequired

configobject | nullOptional

Fields in config
PrismPublicConfig

enabledbooleanRequired

domainstringRequired

platformstring | nullOptional

featuresstring[]Optional

Default: []

Fields in features

Array of string. Default: []

string.

crawlersstring[]Optional

Default: []

Fields in crawlers

Array of string. Default: []

string.

null

null.

usageobject | nullOptional

Fields in usage
PrismPublicUsage

requests_this_monthintegerRequired

requests_limitintegerRequired

percentage_usednumberRequired

reset_datestringRequired

null

null.

401Missing, malformed, or expired credentials

application/json

detailstring | object | nullOptional

errorstring | nullOptional

402The current plan does not fund this operation

application/json

detailstring | object | nullOptional

errorstring | nullOptional

403Invalid credentials, missing brand access, or insufficient role

application/json

detailstring | object | nullOptional

errorstring | nullOptional

422Validation Error

application/json

detailobject[]Optional

Fields in detail

Array of object.

locstring | integer[]Required

Fields in loc

Array of string | integer.

string

string.

integer

integer.

msgstringRequired

typestringRequired

429Rate limit exceeded

application/json

detailstring | object | nullOptional

errorstring | nullOptional

500The operation failed

application/json

detailstring | object | nullOptional

errorstring | nullOptional

503Authentication, entitlement, or a required dependency is temporarily unavailable

application/json

detailstring | object | nullOptional

errorstring | nullOptional

OpenAPI source

Understanding the Data

The response gives you a complete picture of your AI Pages setup:

Domain and Platform

The domain being optimized and how AI Pages is integrated (Cloudflare Workers, Vercel Edge Middleware, Netlify Edge Functions, etc.).

Features

Active optimization features: structured data injection, key facts extraction, automated FAQ generation, AI summary blocks, and entity recognition.

Crawlers

Which AI crawlers are being served optimized pages - GPTBot (ChatGPT), ClaudeBot (Claude), PerplexityBot, OAI-SearchBot, Applebot, and others. Robots-only control tokens such as Google-Extended are not HTTP matches.

Usage

How many AI crawler requests have been served this month relative to your plan limit, with the date when the counter resets.

Not Enabled Response

When AI Pages hasn't been set up for the brand, config and usage are null:

Not Enabled · 200 OK
{
  "brand": {
    "id": "00000000-0000-4000-8000-81f286d10c3c",
    "name": "Notion",
    "website": "https://notion.so"
  },
  "config": null,
  "usage": null
}

Synthetic example. Values are made up.

Requirements

This endpoint requires a paid plan with the AI Pages entitlement. Returns a 403 if your plan does not include this feature.

Brand access is verified - you need effective read access to the brand you are querying.

The legacy path /prism still works as an alias for /ai-pages, but new integrations should use /ai-pages.
Looking for brand perception data (positioning, strengths, weaknesses)? Use GET /get-perception?view=narrative instead.