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

# Introduction

> Welcome to your project

The RankSpot API gives you programmatic access to competitor research, keyword scoring, backlink analysis, forum link-building opportunities, "People Also Ask" mining, and AI-generated content, all from a single REST endpoint.

**Base URL:** `https://api.rankspot.ai/v1`

## Authentication

All requests are authenticated with a bearer token. Pass your API key in the `Authorization` header:

```bash theme={null}
curl -H "Authorization: Bearer $RANKSPOT_API_KEY" \
  https://api.rankspot.ai/v1/keywords
```

<Steps>
  <Step title="Sign up">
    Create an account at [rankspot.ai](https://www.rankspot.ai).
  </Step>

  <Step title="Generate a key">
    Go to **Settings → API Keys** in the RankSpot dashboard and create a new key.
  </Step>

  <Step title="Store it as an env var">
    ```bash theme={null}
    export RANKSPOT_API_KEY=your_key_here
    ```
  </Step>
</Steps>

<Warning>
  Treat your API key like a password. Never commit it to source control or expose it in client-side code.
</Warning>

## Using RankSpot with AI agents

If you're building with Claude, Cursor, VS Code, or another AI agent, you don't need to wire up the API by hand.

<CardGroup cols={2}>
  <Card title="MCP server" icon="plug" href="/docs/mcp-server">
    Connect your agent to `https://mcp.rankspot.ai` and work with your workspace in plain English. OAuth or API key, nothing to install.
  </Card>

  <Card title="RankSpot SEO Skill" icon="github" href="https://github.com/RankSpotAI/rankspot-skill">
    `npx skills add RankSpotAI/rankspot-skill --skill rankspot`
  </Card>
</CardGroup>


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