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

# Introduction

> Read your AI visibility data and manage tracked prompts from your own systems.

The RankRaft AI REST API gives you the same data as the dashboard — Visibility Score, competitors, citations, sentiment, the stored answers, AI crawler and referral traffic, and Action Center cards — plus management of the prompts RankRaft asks the engines every day.

> [!NOTE]
>
> The REST API is part of the **Enterprise** plan. An owner of your organization creates keys in the dashboard under **Settings → API & AI assistants**. On every paid plan you can also connect Claude, ChatGPT and other assistants through the [MCP server](/mcp/introduction).

## Base URL

```text theme={"system"}
https://api.rankraft.ai
```

Every endpoint is versioned under `/v1`. We add fields and endpoints without changing the version; anything that would break an integration gets a new version and advance notice in the [changelog](/api-reference/changelog).

## SDKs

Official clients handle pagination, retries and typed errors for you:

```bash JavaScript theme={"system"}
npm install rankraft-js
```

```bash Python theme={"system"}
pip install rankraft-py
```

See [SDKs](/sdks/overview). Building with an AI coding agent? Install the [RankRaft skill](/skills/rankraft-skill) so it writes correct RankRaft code.

## Your first request

```bash theme={"system"}
curl https://api.rankraft.ai/v1/sites \
  -H "X-API-Key: $RANKRAFT_API_KEY"
```

```json theme={"system"}
{
  "data": [
    {
      "id": "3f2c9a10-7b1e-4c55-9d2a-1a2b3c4d5e6f",
      "name": "Misali Foods",
      "domain": "misalifoods.com",
      "platforms": ["ai_overviews", "ai_mode", "chatgpt", "gemini", "claude"],
      "last_answer_scan": { "date": "2026-10-15", "status": "complete" }
    }
  ]
}
```

Then ask for your Visibility Score over the last month:

```bash theme={"system"}
curl -X POST https://api.rankraft.ai/v1/reports/visibility \
  -H "X-API-Key: $RANKRAFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": "3f2c9a10-7b1e-4c55-9d2a-1a2b3c4d5e6f", "start_date": "2026-09-16", "end_date": "2026-10-15" }'
```

## What you can do

> **[Discovery](/api-reference/endpoints/list-sites)**
>
> Your key, sites, competitors and engines.

> **[Prompts](/api-reference/endpoints/list-prompts)**
>
> List, add, recategorise and switch prompts on or off.

> **[Reports](/api-reference/endpoints/query-visibility)**
>
> Visibility, citations, sentiment and the answers themselves.

> **[Agent Analytics](/api-reference/endpoints/query-bots)**
>
> AI crawler and AI referral traffic from your server logs.

## OpenAPI

The full specification is public at [`https://api.rankraft.ai/v1/openapi.json`](https://api.rankraft.ai/v1/openapi.json). It is generated from the same schemas that validate requests, so it is always exact — import it into Postman, Insomnia or a client generator.


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