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

# Introduction

> SuprKeywords API documentation — keyword research jobs, personas, clusters, and exports

## What is SuprKeywords?

SuprKeywords is an API-first keyword research platform. You provide a primary domain, optional competitor domains, and a language/location. The pipeline generates customer personas, seed keywords, enriches and expands them via our enterprise-grade data provider, then clusters results into pillar and supporting keywords with opportunity scores.

<Card title="Open the dashboard" icon="dashboard" href="https://www.suprkeywords.com/app" horizontal>
  Create jobs, view results, and export keywords from the web app.
</Card>

## What you can do with the API

* **Create jobs** – Submit a keyword research job (primary domain, competitors, locale). One run is debited upfront; the pipeline runs asynchronously.
* **List and inspect jobs** – Get job status, progress, and metadata. When a job is completed or failed, fetch total keyword count and error details.
* **Fetch results** – Get personas, keywords (with filters and pagination), clusters, and keywords within each cluster. Export all keywords as CSV.
* **Locale data** – List available languages and locations for job creation.

The API base URL is **[https://www.suprkeywords.com](https://www.suprkeywords.com)**; all endpoints live under `/api/v1/` (e.g. `https://www.suprkeywords.com/api/v1/jobs`). The dashboard is at [suprkeywords.com/app](https://www.suprkeywords.com/app). **Programmatic access** is authenticated with API keys: create keys in Settings (Agency plan) and send `Authorization: Bearer <your-api-key>` or `X-API-KEY: <your-api-key>`. **Dashboard** users are authenticated via a session cookie in the browser.

<Card title="API Reference" icon="terminal" href="/api-reference/introduction">
  Base URL, authentication, and endpoint reference.
</Card>

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Run a job and fetch results in a few steps.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Endpoints, request/response shapes, and examples.
  </Card>
</CardGroup>