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

# Introduction

> Read and manage your AI-search visibility data over HTTP.

Welcome to the Geoptie API.

The API gives you programmatic access to the same data and actions as the Geoptie dashboard:
visibility across AI engines, the prompts you track, the citations behind each answer,
competitor share of voice, recommendations, and content generation.

<CardGroup cols={2}>
  <Card title="Base URL" icon="link">
    `https://api.geoptie.com`
  </Card>

  <Card title="Quickstart" icon="bolt" href="/docs/quickstart">
    Your first request in under a minute
  </Card>

  <Card title="MCP server" icon="plug" href="/docs/mcp/introduction">
    Use the same data from Claude Code, Cursor or Codex
  </Card>
</CardGroup>

## Who can use it

The API is available to Geoptie subscribers on an active or trialing plan. There is no free
or anonymous tier.

Keys are created in the dashboard under **API keys**, in the sidebar.

## Versions

* **v1** is current and stable, at `https://api.geoptie.com/v1/`.

We may add new fields to responses at any time, so ignore fields you do not recognise rather
than treating them as errors. Breaking changes will ship as `/v2` with 90 days' notice.

## Engines

Use these identifiers wherever an endpoint accepts an `engine` value.

| Identifier            | Engine              |
| --------------------- | ------------------- |
| `chatgpt`             | ChatGPT             |
| `claude`              | Claude              |
| `perplexity`          | Perplexity          |
| `gemini`              | Gemini              |
| `google_ai_overviews` | Google AI Overviews |
| `google_ai_mode`      | Google AI Mode      |
| `copilot`             | Microsoft Copilot   |

Seven engines are available, and each brand tracks any four of them. A brand's current
selection is returned on the brand object.

## Conventions

* **Authentication.** A bearer token on every request. See [Authentication](/docs/authentication).
* **Pagination.** List endpoints are cursor-based. See [Pagination](/docs/pagination).
* **Dates.** ISO 8601, UTC. `from` is inclusive, `to` is exclusive, and omitting both gives
  the last 30 days.
* **Errors.** Standard HTTP status codes plus a stable `error.code`. See [Errors](/docs/errors).

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/docs/quickstart">
    Create a key and make your first request
  </Card>

  <Card title="Authentication" icon="key" href="/docs/authentication">
    Key types, access, and security
  </Card>

  <Card title="Rate limits" icon="gauge" href="/docs/rate-limits">
    How to pace a scheduled job
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/docs/errors">
    Every code and when to retry
  </Card>
</CardGroup>

## Need help

Email [support@geoptie.com](mailto:support@geoptie.com), including the `X-Request-Id` header
from the response so we can find the exact request.