Skip to main content

The Scrunch REST API gives you the same data and configuration as the Scrunch dashboard. Each API has an overview page, then its endpoints. Use this page to find the right one.

Working in Claude, ChatGPT, or another AI assistant? The Scrunch MCP server covers most of these endpoints without any code. See the MCP setup guide.

​
Authentication

Every endpoint takes an API key as a Bearer token. Organization admins create keys by clicking the organization name in the top-left of the Scrunch dashboard and choosing API Keys.
The base URL is https://api.scrunchai.com/v1. The few endpoints that use a different host or version say so on their own page.

​
API scopes

Each key carries one or more scopes and is limited to either specific brands or all brands: Each API’s overview page lists the exact scope its endpoints need. For plan requirements, key rotation, and troubleshooting, see Provision an API key.
Create brands with an all-brands key (leave brands unselected when configuring). A key limited to specific brands can create a brand that it then can’t read, update, or archive.
Calling the API from an AI agent? Install the REST-only api-* Agent Skills. They teach your agent these endpoints, the scopes each one needs, and the behavior the schema doesn’t document. They use the same SCRUNCH_API_TOKEN.

​
Find the right API

​
All APIs

These follow the sections in the sidebar.

​
Measure

How AI platforms talk about your brand, and how AI agents and AI-referred visitors reach your site.

Query API

Aggregated presence, position, sentiment, and citation metrics for BI tools and reports.

Responses API

Every AI response Scrunch collects, with full text, citations, and evaluations.

Signals API

Statistically tested changes and trends in your visibility metrics.

Agent Traffic API

AI bot activity on your sites, plus ingestion from any CDN.

AI Referrals API

Push daily AI referral traffic from Adobe Analytics or other tools.

Collection API

Collect fresh responses for an existing prompt on demand.

​
Optimize

Diagnose and improve your own pages for AI.

Site Optimization API

Recommended fixes by type or page, and the optimizations behind them.

Audit Scores API

Retrievability and citability scores for your site and each page.

Crawl Readiness API

Whether AI crawlers can reach a domain, and what blocks them.

​
Deliver

Serve content to AI agents through Agent Pages, and manage the curated (Adaptive) pages you deploy yourself.

Force Refresh

Republish pages from your live site now, without waiting.

Unpublish

Take curated (Adaptive) pages offline and keep them down.

​
Configure

Set up your account and what Scrunch tracks.

Configuration API

Create and update brands, competitors, personas, and prompts, and list sites.

Account API

The plan, trial status, and billing period behind an API key.

Webhooks

Optimize & Deploy callbacks. Not generally available.

​
Deprecated

These still work for existing integrations. Don’t build anything new on them.

Site Audit API

Audits individual URLs for AI search readiness.

Sitemap API

Lists and exports discovered pages with per-page AI metrics.

AXP Render API

Queues render jobs for pages on an AXP site.

Optimize & Deploy API

One pipeline that audits, optimizes, and deploys pages.

​
Beyond the reference

Quickstart

Make your first call and pull core visibility metrics.

Guides

Walkthroughs for data marts, agent traffic, and more.

MCP and Agent Skills

Use Scrunch from Claude, ChatGPT, and other AI tools.