> ## Documentation Index
> Fetch the complete documentation index at: https://developers.scrunch.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scrunch API Introduction and Authentication

> Programmatic access to AI visibility metrics, raw AI responses, brand configuration, and reporting pipelines through the Scrunch REST APIs.

# Scrunch API Overview

Scrunch gives you programmatic access to the same data and configuration that powers the Scrunch dashboard.\
Use these APIs to query AI visibility metrics, ingest raw AI responses, automate onboarding, update brand configuration, and build custom reporting pipelines.

<a href="/api-reference/query?playground=open" style={{ textDecoration:"none" }}>
  <button style={{ padding:"8px 20px",backgroundColor:"#D8FC3B",color:"black",border:"none",borderRadius:"9999px",fontWeight:500,fontSize:"13px",lineHeight:"1.2",cursor:"pointer",textDecoration:"none",display:"inline-block" }}>
    Playground →
  </button>
</a>

***

## What you can do with the Scrunch API

<CardGroup cols={3}>
  <Card title="Query AI visibility" icon="chart-line">
    Pull metrics like brand presence, sentiment score, position, competitor presence, and source citations across platforms.
  </Card>

  <Card title="Ingest raw AI responses" icon="list-tree">
    Access every response Scrunch collects, including text, citations, persona info, platform, sentiment, and competitor details.
  </Card>

  <Card title="Automate brand management" icon="bolt-auto">
    Programmatically create brands, update configuration, manage prompts, and power internal tooling.
  </Card>
</CardGroup>

***

## Authentication

All endpoints require a Bearer token.\
You can create tokens under **Organization → Settings → API Keys** in the Scrunch dashboard.

```bash theme={null}
export SCRUNCH_API_TOKEN="your-key"

curl -H "Authorization: Bearer $SCRUNCH_API_TOKEN" \
  https://api.scrunchai.com/v1/brands
```

<Note>
  Brand-scoped keys can only access specific brands. Organization-scoped keys can access and configure all brands.
</Note>

## Quickstarts

<Tabs>
  <Tab title="Query API">
    <Card title="Your first query" icon="chart-tree-map" href="/getting-started/quickstart-query">
      Learn how to retrieve brand presence, sentiment, and other key metrics.
    </Card>
  </Tab>

  <Tab title="Responses API">
    <Card title="Ingest raw responses" icon="list-tree" href="/getting-started/quickstart-responses">
      Fetch full response text, citations, competitor details, and more.
    </Card>
  </Tab>

  <Tab title="Looker Studio">
    <Card title="Build BI dashboards" icon="chart-line" href="/integrations/looker-studio">
      Connect Scrunch to Looker Studio and other BI tools.
    </Card>
  </Tab>
</Tabs>

## API References

The full set of endpoints is auto-generated from our OpenAPI specification.

<Card title="Explore endpoints" icon="plug-circle-bolt" href="/api-reference/query/overview">
  Browse Query, Responses, and Configuration endpoints.
</Card>