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

# Are you found by AI? API: endpoints, access and errors

> Endpoints, access, rate limits and error format for the Are you found by AI? HTTP endpoints: the free scan, the x402 agent endpoints and the console data feeds.

Are you found by AI? exposes a small set of HTTP endpoints alongside its [MCP server](/docs/mcp/overview). The free scan endpoint lets you measure any public site programmatically; paid per-call agent endpoints run over x402; and each monitor's console is available as JSON or Markdown. For reading saved scores, verbatim answers and fix plans over time, use the MCP server.

## Base URL

```
https://areyoufoundbyai.com
```

## Available endpoints

| Method | Endpoint | Access | Description |
| - | - | - | - |
| `POST` | `/api/scan` | Free, no auth | One free measurement of a domain as JSON, in about 60 seconds. See [POST /api/scan](/docs/api/scan) |
| `POST` | `/api/agent/scan` | x402, paid per call | A deep measurement paid per call in USDC on Base, with no account and no API key. Currently a preview |
| `GET` | `/api/agent/sov?kw=<category>` | x402, paid per call | AI share of voice for a category. Returns HTTP 402 without payment |
| `GET` | `/monitor/<token>.json` | Monitor token | The whole console as one JSON document |
| `GET` | `/monitor/<token>/context.md` | Monitor token | The same measurements as Markdown, sized to paste into a context window |

The site also publishes a skill card at `/.well-known/agent-skills`, and `/llms.txt` and `/llms-full.txt` for machines.

## Access

`/api/scan` needs no credentials at all: there are no API keys for it, and paid plans do not get a key for it. The other ways in are described in [Authentication](/docs/api/authentication): monitor tokens for the console feeds and MCP, agency keys for the network catalogue, and x402 payment for `/api/agent/*`.

Content-type for `POST` requests is `application/json`.

## Rate limits for the free scan

`/api/scan` is rate-limited per IP each hour, and fair use is 15 free scans per browser per day. On very busy days the free scan can also reach its daily capacity; leave your email and the scan runs automatically when capacity frees, with the result sent to you. A recent result for the same site may be returned from cache.

Pro monitoring does not run through `/api/scan`. Pro checks up to 25 buyer questions across seven engines on the schedule you choose (weekly, monthly or whenever you like), spending tokens from your account, and you read the results in your console or over MCP.

## Error format

Errors from `/api/scan` return a JSON body with a human-readable message:

```json theme={null}
{
  "error": "Enter a valid website address."
}
```

| HTTP status | Meaning |
| - | - |
| `400` | The `url` is missing or is not a valid website address |
| `429` | The hourly limit, the daily per-browser allowance or the daily scan capacity has been reached. The message says which |
| `500` | The scan failed. The message carries the reason |

<Tip>
  Pass a fully qualified public URL, including the scheme, for example `https://example.com`.
</Tip>

## Explore further

<CardGroup cols={3}>
  <Card title="Scan API" icon="radar" href="/docs/api/scan">
    Request and response reference for `POST /api/scan`, with code examples.
  </Card>

  <Card title="Authentication" icon="key" href="/docs/api/authentication">
    What authenticates where: monitor tokens, agency keys and x402.
  </Card>

  <Card title="MCP Tools" icon="plug" href="/docs/mcp/tools">
    MCP tools for reading scores, verbatim answers, crawler access, fix plans and more: 20 on the demo, more on a customer token.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.