# Connect a CMS integration
Source: https://docs.keupera.com/api-reference/account-&-utilities/connect-a-cms-integration

/api-reference/openapi.json post /connect
Registers a CMS integration against your API key. Used by the Framer plugin and WordPress connector.



# Verify credentials
Source: https://docs.keupera.com/api-reference/account-&-utilities/verify-credentials

/api-reference/openapi.json get /me
Returns basic profile info for the authenticated user. This endpoint skips the paid-tier check and works on any valid API key — use it to verify that a key is valid regardless of subscription tier.



# AI Visibility
Source: https://docs.keupera.com/api-reference/ai-visibility

Brand Radar campaigns, the Prompt Research Engine, and aggregated visibility scores.

Track how your brand — and your competitors — appear across LLM answers. This module exposes Brand Radar campaigns, the Prompt Research Engine, and a consolidated visibility score. Every endpoint below has a live playground in the sidebar.

## What you can do

<CardGroup>
  <Card title="Brand Radar" icon="satellite-dish">
    Monitor a prompt across LLMs and track brand vs. competitor mentions, ranks, and context over time.
  </Card>

  <Card title="Prompt Research Engine" icon="flask">
    Research a custom prompt across AI models on a schedule and get clustered, analyzed results.
  </Card>

  <Card title="Visibility Score" icon="gauge-high">
    Pull one aggregated overview across Brand Radar, Prompt Research, Authority, and Funnel.
  </Card>

  <Card title="Manage campaigns" icon="sliders">
    Create, update frequency and status, toggle competitors, and delete campaigns.
  </Card>
</CardGroup>

## Concepts

* **Frequency** — how often (in days) a campaign re-runs against the LLMs. Defaults to `7`.
* **Languages** — each campaign can run its prompt in up to **3** languages; defaults to `["en"]`.
* **Visibility score** — a 0–100 measure of how prominently your brand appears in the generated answers for a campaign's prompt.

<Note>
  `GET /score` is the fastest way to get a single-call snapshot of AI visibility across every sub-feature for a website.
</Note>


# Create a Brand Radar campaign
Source: https://docs.keupera.com/api-reference/ai-visibility/create-a-brand-radar-campaign

/api-reference/openapi.json post /brand-radar/campaigns
Creates a Brand Radar campaign that monitors a prompt across LLMs and tracks brand and competitor mentions.



# Create a Prompt Research campaign
Source: https://docs.keupera.com/api-reference/ai-visibility/create-a-prompt-research-campaign

/api-reference/openapi.json post /prompt-research/campaigns
Creates a Prompt Research Engine campaign that researches a custom prompt across AI models on a schedule.



# Delete a Brand Radar campaign
Source: https://docs.keupera.com/api-reference/ai-visibility/delete-a-brand-radar-campaign

/api-reference/openapi.json delete /brand-radar/campaigns/{id}
Deletes a Brand Radar campaign.



# Get AI Visibility Score
Source: https://docs.keupera.com/api-reference/ai-visibility/get-ai-visibility-score

/api-reference/openapi.json get /score
Returns an aggregated overview across all AI visibility sub-features — Brand Radar, Prompt Research, Authority, and Funnel.



# Get Brand Radar results
Source: https://docs.keupera.com/api-reference/ai-visibility/get-brand-radar-results

/api-reference/openapi.json get /brand-radar/campaigns/{id}/results
Returns the run results for a Brand Radar campaign, including mentions and visibility scores.



# Get Prompt Research campaign
Source: https://docs.keupera.com/api-reference/ai-visibility/get-prompt-research-campaign

/api-reference/openapi.json get /prompt-research/campaigns/{id}
Returns a Prompt Research campaign together with its analyzed run results.



# List Brand Radar campaigns
Source: https://docs.keupera.com/api-reference/ai-visibility/list-brand-radar-campaigns

/api-reference/openapi.json get /brand-radar/campaigns
Returns all Brand Radar campaigns for a website.



# List Prompt Research campaigns
Source: https://docs.keupera.com/api-reference/ai-visibility/list-prompt-research-campaigns

/api-reference/openapi.json get /prompt-research/campaigns
Returns all Prompt Research Engine campaigns for a website.



# Update a Brand Radar campaign
Source: https://docs.keupera.com/api-reference/ai-visibility/update-a-brand-radar-campaign

/api-reference/openapi.json patch /brand-radar/campaigns/{id}
Updates a Brand Radar campaign's frequency or status, or toggles competitor tracking.



# Analytics
Source: https://docs.keupera.com/api-reference/analytics

Website traffic, Google Search Console data, and AI bot crawl activity.

Query traffic and performance data for your website, cached Google Search Console stats, and AI bot crawl activity. Every endpoint below has a live playground in the sidebar.

## What you can do

<CardGroup>
  <Card title="Website analytics" icon="chart-simple">
    Summary, daily series, top pages, referrers, and device / browser / geo breakdowns.
  </Card>

  <Card title="Search Console" icon="magnifying-glass-chart">
    Cached GSC daily stats plus top keywords and pages.
  </Card>

  <Card title="Bot traffic" icon="robot">
    AI bot crawl activity by bot, by day, and by most-crawled page.
  </Card>
</CardGroup>

## Date range parameters

Every analytics endpoint accepts the same date-range parameters:

<ParamField type="string">
  Preset range — one of `7d`, `30d`, `90d`.
</ParamField>

<ParamField type="string">
  Start date (`YYYY-MM-DD`).
</ParamField>

<ParamField type="string">
  End date (`YYYY-MM-DD`).
</ParamField>

<Note>
  When both `from` and `to` are provided, `range` is ignored.
</Note>


# Bot traffic summary
Source: https://docs.keupera.com/api-reference/analytics/bot-traffic-summary

/api-reference/openapi.json get /bot-traffic/summary
Returns AI bot crawl activity aggregated by bot.



# Browser breakdown
Source: https://docs.keupera.com/api-reference/analytics/browser-breakdown

/api-reference/openapi.json get /website/browsers
Returns traffic broken down by browser.



# Daily bot traffic
Source: https://docs.keupera.com/api-reference/analytics/daily-bot-traffic

/api-reference/openapi.json get /bot-traffic/daily
Returns daily AI bot crawl activity per bot.



# Daily traffic
Source: https://docs.keupera.com/api-reference/analytics/daily-traffic

/api-reference/openapi.json get /website/daily
Returns daily traffic time series.



# Device breakdown
Source: https://docs.keupera.com/api-reference/analytics/device-breakdown

/api-reference/openapi.json get /website/devices
Returns traffic broken down by device type.



# Geographic traffic
Source: https://docs.keupera.com/api-reference/analytics/geographic-traffic

/api-reference/openapi.json get /website/geo
Returns traffic broken down by country.



# Referrers
Source: https://docs.keupera.com/api-reference/analytics/referrers

/api-reference/openapi.json get /website/referrers
Returns top traffic sources.



# Search Console daily stats
Source: https://docs.keupera.com/api-reference/analytics/search-console-daily-stats

/api-reference/openapi.json get /search-console/daily
Returns cached Google Search Console daily performance.



# Search Console top keywords
Source: https://docs.keupera.com/api-reference/analytics/search-console-top-keywords

/api-reference/openapi.json get /search-console/keywords
Returns top-performing keywords from Google Search Console.



# Search Console top pages
Source: https://docs.keupera.com/api-reference/analytics/search-console-top-pages

/api-reference/openapi.json get /search-console/pages
Returns top-performing pages from Google Search Console.



# Top crawled pages
Source: https://docs.keupera.com/api-reference/analytics/top-crawled-pages

/api-reference/openapi.json get /bot-traffic/top-pages
Returns the pages most crawled by AI bots.



# Top pages
Source: https://docs.keupera.com/api-reference/analytics/top-pages

/api-reference/openapi.json get /website/top-pages
Returns the most-viewed pages.



# Website summary
Source: https://docs.keupera.com/api-reference/analytics/website-summary

/api-reference/openapi.json get /website/summary
Returns aggregate web analytics from your Keupera tracking script.



# Backlinks
Source: https://docs.keupera.com/api-reference/backlinks

Manage backlink campaigns, opportunities, and outreach emails.

Run backlink research campaigns, work the opportunities discovered for each campaign, and generate or send personalized outreach emails. Every endpoint below has a live playground in the sidebar.

## What you can do

<CardGroup>
  <Card title="Run campaigns" icon="rocket">
    Create a campaign for a keyword and niche; opportunity research runs automatically in the background.
  </Card>

  <Card title="Work opportunities" icon="bullseye">
    List, inspect, and update discovered opportunities — status, contact details, and notes.
  </Card>

  <Card title="Generate outreach" icon="envelope">
    Produce an AI-written, personalized outreach email for any opportunity.
  </Card>

  <Card title="Send outreach" icon="paper-plane">
    Send the email through your organization's configured SMTP and track the response.
  </Card>
</CardGroup>

## Concepts

* **`target_domain`** — the domain a campaign researches backlinks for. Defaults to the website's own domain; set it to research a subdomain or partner site instead.
* **Opportunity scoring** — each opportunity carries a `relevance_score` (0–100), `domain_authority`, `domain_rating`, estimated `monthly_traffic`, and AI `reasoning` explaining why it surfaced.

<Note>
  Backlink opportunity research is triggered automatically once a campaign is created — poll the campaign's `progress` field or list its opportunities to watch results arrive.
</Note>

<Warning>
  Organization SMTP settings must be configured under **Settings** before you can send outreach emails.
</Warning>


# Create campaign
Source: https://docs.keupera.com/api-reference/backlinks/create-campaign

/api-reference/openapi.json post /campaigns
Creates a backlink research campaign. Opportunity research is triggered automatically in the background once the campaign is created. Consumes backlink research credits.



# Generate an outreach email
Source: https://docs.keupera.com/api-reference/backlinks/generate-an-outreach-email

/api-reference/openapi.json post /opportunities/{id}/generate-email
Generates an AI-written, personalized outreach email for an opportunity. Consumes AI credits.



# Get an opportunity
Source: https://docs.keupera.com/api-reference/backlinks/get-an-opportunity

/api-reference/openapi.json get /opportunities/{id}
Returns a single backlink opportunity, including its parent campaign context.



# Get campaign details
Source: https://docs.keupera.com/api-reference/backlinks/get-campaign-details

/api-reference/openapi.json get /campaigns/{id}
Returns a single campaign, including research progress.



# Get strategic recommendations
Source: https://docs.keupera.com/api-reference/backlinks/get-strategic-recommendations

/api-reference/openapi.json get /campaigns/{id}/recommendations
Returns AI-generated link-building strategy recommendations for a campaign.



# List campaign opportunities
Source: https://docs.keupera.com/api-reference/backlinks/list-campaign-opportunities

/api-reference/openapi.json get /campaigns/{id}/opportunities
Returns backlink opportunities discovered for a campaign.



# List campaigns
Source: https://docs.keupera.com/api-reference/backlinks/list-campaigns

/api-reference/openapi.json get /campaigns
Returns all backlink campaigns for a website.



# Send an outreach email
Source: https://docs.keupera.com/api-reference/backlinks/send-an-outreach-email

/api-reference/openapi.json post /opportunities/{id}/send-email
Sends an outreach email for an opportunity via your organization's configured SMTP. Organization SMTP settings must be configured under **Settings** before sending. Updates the opportunity status to `outreach_sent`.



# Update an opportunity
Source: https://docs.keupera.com/api-reference/backlinks/update-an-opportunity

/api-reference/openapi.json patch /opportunities/{id}
Updates the status, contact details, or notes on an opportunity.



# Content
Source: https://docs.keupera.com/api-reference/content

Plan, generate, update, and publish AI-written articles, plus content automation.

Manage blog articles across the full content pipeline — planning, AI generation, scheduling, and publishing — and configure content automation per website. Every endpoint below has a live playground in the sidebar.

## What you can do

<CardGroup>
  <Card title="Plan articles" icon="calendar-plus">
    Create an article from a title or a linked keyword, with an optional outline and schedule date.
  </Card>

  <Card title="Generate with AI" icon="wand-magic-sparkles">
    Kick off the generation pipeline for a planned article, then update, schedule, and publish it.
  </Card>

  <Card title="View the calendar" icon="calendar-days">
    Fetch scheduled article events within a date range for your editorial calendar.
  </Card>

  <Card title="Automate the pipeline" icon="gears">
    Read and update per-website automation — auto-plan, auto-generate, auto-publish, and more.
  </Card>
</CardGroup>

## The content pipeline

Articles move through `planned → queued → in-progress → completed → published`. Plan with `POST /articles`, start generation with `POST /articles/{id}/generate`, then patch status and schedule fields as the article progresses.

<Note>
  Deleting an article that's linked to a keyword reverts that keyword's status back to `active`.
</Note>

<Warning>
  The `GET /blog-posts` and `GET /blog-posts/{id}` endpoints are **legacy** and marked deprecated. Use the `/articles` endpoints going forward.
</Warning>


# Create an article
Source: https://docs.keupera.com/api-reference/content/create-an-article

/api-reference/openapi.json post /articles
Plans a new article. Provide either a `title` or a `keyword_id`. Optionally pass an `outline` for AI-assisted drafting and a `date` to schedule publishing.



# Delete an article
Source: https://docs.keupera.com/api-reference/content/delete-an-article

/api-reference/openapi.json delete /articles/{id}
Deletes an article. If the article is linked to a keyword, the keyword status is reverted to `active`.



# Get a blog post (legacy)
Source: https://docs.keupera.com/api-reference/content/get-a-blog-post-legacy

/api-reference/openapi.json get /blog-posts/{id}
**Legacy.** Use `GET /articles/{id}` going forward.



# Get an article
Source: https://docs.keupera.com/api-reference/content/get-an-article

/api-reference/openapi.json get /articles/{id}
Returns full article details, including linked keyword data.



# Get automation settings
Source: https://docs.keupera.com/api-reference/content/get-automation-settings

/api-reference/openapi.json get /automation
Returns the content automation settings for a website.



# Get calendar events
Source: https://docs.keupera.com/api-reference/content/get-calendar-events

/api-reference/openapi.json get /articles/calendar
Returns scheduled article events within a date range.



# List articles
Source: https://docs.keupera.com/api-reference/content/list-articles

/api-reference/openapi.json get /articles
Returns a paginated list of articles for a website.



# List blog posts (legacy)
Source: https://docs.keupera.com/api-reference/content/list-blog-posts-legacy

/api-reference/openapi.json get /blog-posts
**Legacy.** Use `GET /articles` going forward.



# Trigger article generation
Source: https://docs.keupera.com/api-reference/content/trigger-article-generation

/api-reference/openapi.json post /articles/{id}/generate
Starts the AI content generation pipeline for a planned article. Consumes AI credits.



# Update an article
Source: https://docs.keupera.com/api-reference/content/update-an-article

/api-reference/openapi.json patch /articles/{id}
Updates article fields. The `date` field is a shortcut that sets both `published_at` and `scheduled_publish_at`.



# Update automation settings
Source: https://docs.keupera.com/api-reference/content/update-automation-settings

/api-reference/openapi.json patch /automation
Updates the content automation settings for a website.



# API Overview
Source: https://docs.keupera.com/api-reference/introduction

Base URL, authentication, pagination, and error handling for the Keupera Public API.

The **Keupera Public API** gives you programmatic access to every major platform module — Keyword Research, Backlinks, Content, AI Visibility, and Analytics. Every endpoint on the left has a **live playground**: add your API key and send real requests straight from these docs.

<CardGroup>
  <Card title="Keywords" icon="magnifying-glass" href="/api-reference/keywords">
    Research, enrich, star, and group keywords.
  </Card>

  <Card title="Backlinks" icon="link" href="/api-reference/backlinks">
    Run campaigns and generate outreach.
  </Card>

  <Card title="Content" icon="pen-nib" href="/api-reference/content">
    Plan, generate, and publish articles.
  </Card>

  <Card title="AI Visibility" icon="robot" href="/api-reference/ai-visibility">
    Track your brand across LLM answers.
  </Card>

  <Card title="Analytics" icon="chart-line" href="/api-reference/analytics">
    Traffic, Search Console, and bot data.
  </Card>

  <Card title="Account" icon="user" href="/api-reference/utilities">
    Verify keys and connect a CMS.
  </Card>
</CardGroup>

## Base URL

All resources are served under a single versioned prefix:

```bash theme={null}
https://app.keupera.com/api/v1
```

## Authentication

Every request must include your API key as a Bearer token:

```http theme={null}
Authorization: Bearer YOUR_KEUPERA_API_KEY
```

Generate keys from **Account → API Keys** in your [Keupera dashboard](https://app.keupera.com). Each key:

* Belongs to a single user and is bound to **one website by default** (configurable in the dashboard).
* Requires a paid subscription tier with API access enabled.
* Only sees websites within your organization(s).

<Warning>
  Your subscription plan must include Public API access. Requests from plans without API entitlement return `403 Forbidden`. Never ship a key in a browser — always proxy requests through your own backend.
</Warning>

## Make your first request

<Steps>
  <Step title="Grab your API key">
    Open **Account → API Keys** in the [dashboard](https://app.keupera.com) and copy a key.
  </Step>

  <Step title="Verify it works">
    Call `GET /me` — it works on any valid key regardless of subscription tier, so it's the fastest way to confirm authentication.

    <CodeGroup>
      ```bash cURL theme={null}
      curl https://app.keupera.com/api/v1/me \
        -H "Authorization: Bearer YOUR_KEUPERA_API_KEY"
      ```

      ```js Node.js theme={null}
      const res = await fetch("https://app.keupera.com/api/v1/me", {
        headers: { Authorization: `Bearer ${process.env.KEUPERA_API_KEY}` },
      });
      const { data } = await res.json();
      console.log(data.email);
      ```

      ```python Python theme={null}
      import os, requests

      res = requests.get(
          "https://app.keupera.com/api/v1/me",
          headers={"Authorization": f"Bearer {os.environ['KEUPERA_API_KEY']}"},
      )
      print(res.json()["data"]["email"])
      ```
    </CodeGroup>
  </Step>

  <Step title="Fetch some data">
    List your keywords. Use the **API Explorer** on any endpoint page to try it live and copy the generated code.

    ```bash theme={null}
    curl "https://app.keupera.com/api/v1/keywords?limit=10" \
      -H "Authorization: Bearer YOUR_KEUPERA_API_KEY"
    ```
  </Step>
</Steps>

## Scoping to a specific website

If your key is bound to a website, every request defaults to that website. To target a different website you own, pass `website_id` as a query parameter:

```http theme={null}
GET /api/v1/keywords?website_id=<uuid>
```

The website must belong to one of your organizations, otherwise the API returns `403`.

## Common parameters

Most list endpoints accept pagination, and analytics endpoints accept a date range.

<ParamField type="uuid">
  Override the target website. Defaults to the API key's website.
</ParamField>

<ParamField type="integer">
  Number of results to return. Default varies per endpoint.
</ParamField>

<ParamField type="integer">
  Page number for paginated endpoints.
</ParamField>

<ParamField type="string">
  Analytics only. Preset date range — one of `7d`, `30d`, `90d`.
</ParamField>

<ParamField type="string">
  Analytics only. Start date (`YYYY-MM-DD`).
</ParamField>

<ParamField type="string">
  Analytics only. End date (`YYYY-MM-DD`).
</ParamField>

<Note>
  When both `from` and `to` are provided, `range` is ignored.
</Note>

## Response format

All responses are JSON and follow a consistent envelope.

<CodeGroup>
  ```json Success theme={null}
  {
    "data": [ /* ... */ ],
    "meta": {
      "total": 150,
      "page": 1,
      "limit": 20
    }
  }
  ```

  ```json Error theme={null}
  { "error": "Descriptive error message" }
  ```
</CodeGroup>

List endpoints wrap results in `data` and add a `meta` object for pagination. Single-resource endpoints return the object directly under `data`.

## HTTP status codes

| Code  | Meaning                                                          |
| ----- | ---------------------------------------------------------------- |
| `200` | Success                                                          |
| `201` | Created                                                          |
| `202` | Accepted — long-running job queued                               |
| `400` | Bad request — missing or invalid parameters                      |
| `401` | Unauthorized — missing or invalid API key                        |
| `402` | Usage limit reached — crawl credits, AI credits, etc. exhausted  |
| `403` | Forbidden — inactive key, no API access, or unauthorized website |
| `404` | Not found                                                        |
| `500` | Internal server error                                            |

## Rate limits & usage

Each API call counts against your plan's limits the same way in-app actions do. When a limit is reached the API responds with `402 Payment Required`. Enable metered billing in **Account → Billing → Usage** to allow overage.

| Resource                               | Routes that consume it                                                                    |
| -------------------------------------- | ----------------------------------------------------------------------------------------- |
| `keyword_research` (10 crawl credits)  | `POST /keywords/research`, enrichment in `POST /keywords`                                 |
| `backlink_research` (20 crawl credits) | `POST /campaigns`                                                                         |
| `ai_credits` (per-token)               | `POST /opportunities/:id/generate-email`, `POST /articles`, `POST /articles/:id/generate` |
| `crawl_credits`                        | Enrichment, GSC syncs                                                                     |

## Handling errors

<AccordionGroup>
  <Accordion title="401 — Invalid or missing API key" icon="key">
    Confirm the `Authorization: Bearer <key>` header is present and the key is active. Test with `GET /me`, which bypasses the paid-tier check.
  </Accordion>

  <Accordion title="402 — Usage limit reached" icon="credit-card">
    You've exhausted a credit bucket (keyword research, backlink research, or AI credits). Enable metered billing under **Account → Billing → Usage** to allow overage, or wait for the next cycle.
  </Accordion>

  <Accordion title="403 — Forbidden" icon="ban">
    Either your plan doesn't include Public API access, the key is inactive, or the `website_id` you passed isn't in one of your organizations.
  </Accordion>

  <Accordion title="Long-running jobs (202)" icon="clock">
    `POST /keywords/research` returns a `job_id`. Poll `GET /keywords/research/{jobId}` until `status` is `completed` or `failed`. Avoid `sync: true` in production — it's subject to gateway timeouts.
  </Accordion>
</AccordionGroup>

## CORS

All endpoints respond with `Access-Control-Allow-Origin: *`, so they can be called from any origin — but never ship a key in a browser. Always proxy requests through your own backend.

## Prefer natural language?

Connect the [Keupera MCP Server](/mcp/introduction) to run these same operations from Claude, Cursor, or any MCP-compatible client without writing HTTP calls yourself.


# Keywords
Source: https://docs.keupera.com/api-reference/keywords

Research, enrich, and manage keywords and keyword groups.

Manage keyword research programmatically — list, add, delete, star, bulk-update status, trigger AI-powered research, and organize keywords into groups. Every endpoint below has a live playground in the sidebar.

## What you can do

<CardGroup>
  <Card title="Manage keywords" icon="list-check">
    List with filters, add in bulk (with optional enrichment), delete, star, and bulk-update status.
  </Card>

  <Card title="Run AI research" icon="wand-magic-sparkles">
    Expand seed terms into ranked keyword ideas with DataForSEO enrichment.
  </Card>

  <Card title="Organize into groups" icon="folder-tree">
    List keyword groups and assign keywords to them (groups are auto-created on add).
  </Card>

  <Card title="Enrich on demand" icon="database">
    Pass `enrich: true` when adding keywords to auto-fill volume, difficulty, CPC, and intent.
  </Card>
</CardGroup>

## The research job flow

`POST /keywords/research` is a **long-running** operation. It returns a `job_id` immediately with `202 Accepted` — poll `GET /keywords/research/{jobId}` until `status` is `completed` or `failed`.

<Steps>
  <Step title="Start the job">
    `POST /keywords/research` with your `seed_keywords`. You get back `{ "job_id", "status": "pending", "poll_url" }`.
  </Step>

  <Step title="Poll for completion">
    `GET /keywords/research/{jobId}` returns `status` — one of `pending`, `processing`, `completed`, or `failed`. Results land in `result` when done.
  </Step>
</Steps>

<Warning>
  Avoid `sync: true` in production — it waits inline and is subject to gateway timeouts. Keyword research consumes crawl credits and returns `402` when your quota is exhausted.
</Warning>


# Add keywords
Source: https://docs.keupera.com/api-reference/keywords/add-keywords

/api-reference/openapi.json post /keywords
Adds one or more keywords to a website. Set `enrich: true` to auto-fill volume, difficulty, CPC, and intent via DataForSEO — this consumes keyword research credits.



# Bulk update keyword status
Source: https://docs.keupera.com/api-reference/keywords/bulk-update-keyword-status

/api-reference/openapi.json patch /keywords/status
Updates the status of multiple keywords in a single request.



# Delete keywords
Source: https://docs.keupera.com/api-reference/keywords/delete-keywords

/api-reference/openapi.json delete /keywords
Deletes one or more keywords by ID.



# List keyword groups
Source: https://docs.keupera.com/api-reference/keywords/list-keyword-groups

/api-reference/openapi.json get /keywords/groups
Returns all keyword groups for a website.



# List keywords
Source: https://docs.keupera.com/api-reference/keywords/list-keywords

/api-reference/openapi.json get /keywords
Returns a paginated list of keywords for the authenticated website.



# Poll a research job
Source: https://docs.keupera.com/api-reference/keywords/poll-a-research-job

/api-reference/openapi.json get /keywords/research/{jobId}
Returns the current state of a keyword research job. Poll until `status` is `completed` or `failed`.



# Toggle keyword star
Source: https://docs.keupera.com/api-reference/keywords/toggle-keyword-star

/api-reference/openapi.json patch /keywords/{id}/star
Stars or unstars a keyword.



# Trigger keyword research
Source: https://docs.keupera.com/api-reference/keywords/trigger-keyword-research

/api-reference/openapi.json post /keywords/research
Generates keyword ideas using AI plus DataForSEO enrichment.

This is a **long-running job**. By default the endpoint returns a job handle immediately (`202 Accepted`) — poll `GET /keywords/research/{jobId}` with the returned `job_id` until `status` is `completed`. Pass `"sync": true` to wait inline, but this is not recommended as it is subject to gateway timeouts.

Consumes keyword research credits.



# Account & Utilities
Source: https://docs.keupera.com/api-reference/utilities

Verify credentials, connect a CMS, and reference internal endpoints and webhooks.

Account-level and utility endpoints. `GET /me` and `POST /connect` have live playgrounds in the sidebar; the internal endpoints below are documented for reference only.

## What you can do

<CardGroup>
  <Card title="Verify credentials" icon="key">
    `GET /me` returns basic profile info and works on any valid key — the fastest way to test authentication.
  </Card>

  <Card title="Connect a CMS" icon="plug">
    `POST /connect` registers a Framer or WordPress integration against your API key.
  </Card>
</CardGroup>

<Tip>
  `GET /me` skips the paid-tier check, so it succeeds on any valid API key regardless of subscription. Use it in health checks and setup wizards to confirm a key is live.
</Tip>

## Internal endpoints

These endpoints exist on the API surface but are not intended for direct integration.

### Track bot hit

```http theme={null}
POST /track-bot
```

Used by the Keupera in-page tracker script to record AI bot visits. **Not intended for direct integration** — read the data via the [Analytics bot-traffic endpoints](/api-reference/analytics) instead.

## Webhooks

Configure outbound webhooks in **Account → Integrations**. Keupera will `POST` a JSON payload to your endpoint on the events you subscribe to.

### Inbound webhooks

| Path                         | Purpose                                                        |
| ---------------------------- | -------------------------------------------------------------- |
| `POST /api/v1/polar-webhook` | Polar billing events (Keupera-internal — do not call directly) |


# AI Funnel
Source: https://docs.keupera.com/features/ai-funnel

Simulate AI conversations to measure your brand's presence.

The **AI Decision Funnel** (part of AI Studio) maps out how well your brand performs throughout the stages of an AI-led customer journey.

## Simulating the AI Journey

Instead of a static snapshot, the AI Funnel simulates a multi-turn conversation between a user and an AI model:

* **Awareness**: When a user asks a broad question about a problem or category.
* **Consideration**: When a user narrows down their options.
* **Decision**: When the AI recommends a specific brand or solution.

## Funnel Campaigns

A **Funnel Campaign** runs these simulations periodically, letting you see exactly where your brand drops off the AI's radar or where a competitor suddenly gains the upper hand. The goal is to ensure your brand survives the funnel, from the initial question to the final recommendation.


# Analytics
Source: https://docs.keupera.com/features/analytics

Deep dive into your search performance and traffic insights.

The **Analytics** module integrates data from your website traffic and Google Search Console (GSC) to provide a unified view of your organic performance.

## Overview

The Analytics view provides an aggregated summary of your website's performance:

* **Total Visits & Pageviews**
* **Average Visit Duration & Bounce Rate**
* **Devices & Browsers Breakdown**
* **Geographic Traffic**

## Search Performance

By integrating with Google Search Console, Keupera brings your search metrics right into the platform:

* **Top Pages & Keywords**: See which URLs and queries bring in the most organic clicks.
* **Position Distribution**: Understand how many keywords rank in the Top 3, Pos 4-10, Pos 11-20, etc.
* **Striking Distance Keywords**: Identify keywords ranking on page 2 (positions 11-20) with high impressions that are prime targets for optimization.
* **Keyword Cannibalization**: Spot instances where multiple pages on your site are competing for the same search term.

## AI Bot Traffic

A unique feature of Keupera Analytics is **AI Bot Traffic Tracking**. We identify and summarize visits from AI crawlers (like OpenAI, Anthropic, or Perplexity bots), showing you:

* Which AI bots are indexing your site.
* The specific paths and pages they are visiting most frequently.


# Authority Layer
Source: https://docs.keupera.com/features/authority

Audit your brand's presence on platforms AI models trust.

The **Authority Layer** (part of AI Studio) focuses on third-party validation. AI models don't just trust what you say about yourself; they look for corroboration from authoritative sources.

## Trust Signals

This tool audits your brand's presence across platforms that serve as key trust signals for AI:

* **Review Sites**: G2, Capterra, Trustpilot.
* **Directories**: Wikipedia, Crunchbase, industry-specific listings.
* **News & PR**: High-authority publications mentioning your brand.

## Authority Campaigns

An **Authority Campaign** calculates an **Authority Score** based on the breadth and quality of these external sources. It helps you identify which platforms you need to target to improve your overall reputation in the eyes of an LLM.


# Backlinks
Source: https://docs.keupera.com/features/backlinks

Manage backlink campaigns and track link building opportunities.

The **Backlinks** module is designed to help you discover, evaluate, and manage high-quality link-building opportunities.

## Campaign Management

You can create organized **Backlink Campaigns** targeted around specific pages or goals. Each campaign acts as a central workspace for tracking outreach and success.

## Finding Opportunities

Keupera automatically highlights potential backlinks tailored to your domain's niche and content. You can review opportunities based on:

* **Domain Authority**: Evaluating the trust and strength of the referring site.
* **Relevance**: Ensuring the linking site is contextually aligned with your business.
* **Status Tracking**: Keep tabs on whether a link has been requested, is in progress, or successfully acquired.

## Reporting

In Agency Mode or for internal tracking, you can generate reports demonstrating the growth of your backlink profile over time, directly contributing to your overall SEO authority.


# Brand Radar
Source: https://docs.keupera.com/features/brand-radar

Track how AI models mention and perceive your brand.

The **Brand Radar** (part of AI Studio) helps you understand if and how Large Language Models (LLMs) like ChatGPT, Claude, and Gemini talk about you.

## How It Works

By setting up **Brand Radar Campaigns**, you tell Keupera to regularly query AI models about your brand, products, or industry.

* **Visibility Score**: An aggregate metric indicating how often your brand appears in relevant AI responses.
* **Sentiment Analysis**: Whether the AI models speak positively, neutrally, or negatively about your offerings.
* **Competitor Mentions**: See which of your competitors are being recommended alongside or instead of you.

## Why It Matters

As users increasingly turn to AI for recommendations instead of traditional search engines, ensuring your brand is part of the AI's "knowledge base" is critical. Brand Radar alerts you if you're losing visibility to competitors in this new ecosystem.


# Calendar
Source: https://docs.keupera.com/features/calendar

Schedule, organize, and plan your SEO content pipeline.

The **Calendar** feature is designed for planning your content strategy in a structured, timeline-based format.

## Overview

A visual representation of your upcoming articles, blog posts, and landing pages, the Calendar allows you to:

* Schedule publishing dates.
* Assign topics to specific writers or campaigns.
* See which content is currently in progress, under review, or published.

## Agency Mode

If you're using Keupera as an agency, the Calendar becomes an essential tool for managing client deliverables. You can switch between clients to view customized content schedules, assign To-Do's to team members, and ensure that every piece is moving forward.


# Competitors
Source: https://docs.keupera.com/features/competitors

Analyze and benchmark against competing domains.

The **Competitors** tool allows you to track rival websites and uncover strategic gaps in your own content and AI visibility.

## Tracking Competitors

You can add multiple competitor domains to your dashboard to monitor their performance over time. Keupera not only lets you add known competitors manually but also automatically suggests them based on AI visibility and search overlap via **Brand Radar Suggestions**.

## Deep Analysis

By running a deep analysis on a tracked competitor, you gain access to:

* **Market Overlap**: Understanding how much your audience intersects with theirs.
* **Main Topics**: Identifying the core subject areas their content focuses on.
* **Top Keywords**: Exposing the high-value search terms driving traffic to their site.
* **Content Gaps**: Seeing exactly where they rank for terms you currently don't.

## Reporting

All competitor data is stored and updated over time, allowing you to generate reports and track if the gap is widening or closing across search and AI recommendation engines.


# Dashboard
Source: https://docs.keupera.com/features/dashboard

Overview of your SEO and AI visibility metrics.

The **Dashboard** is your central hub for monitoring your site's search performance and AI visibility. It provides a comprehensive, high-level summary of how your brand is performing across different channels.

## Key Metrics

On the Dashboard, you'll find an immediate summary of:

* **Organic Traffic**: Total visits from search engines over a specific timeframe.
* **Top Ranking Keywords**: A quick glimpse of keywords driving the most traffic.
* **AI Brand Visibility**: Overall score of how frequently and positively your brand is mentioned by major AI models (like ChatGPT and Claude).

## Quick Actions

From the Dashboard, you can quickly jump into core modules:

* Navigate to **Analytics** for deeper data dives.
* Access the **AI Studio** tools to measure and improve AI model recommendations.
* Launch a new **Content** creation session.

## Organization & Site Selection

If you manage multiple properties or work within an agency, use the site selector in the top navigation to switch contexts. The Dashboard dynamically updates to reflect the data of the currently selected property.


# Editor
Source: https://docs.keupera.com/features/editor

Write and optimize content with real-time SEO intelligence.

The **Editor** is an intelligent writing environment designed to help you create high-ranking content.

## Real-Time Optimization

As you write, the Editor provides feedback and suggestions based on target keywords, helping you optimize:

* Title Tags and Meta Descriptions.
* Heading structure (H1, H2, H3).
* Keyword density and placement.
* Readability and content length.

## Collaboration

The Editor supports commenting and review workflows, allowing teams and agencies to collaborate on drafts before they go live.

## AI Assistance

You can utilize AI tools directly within the Editor to generate outlines, suggest content angles, or refine paragraphs to ensure your article aligns perfectly with user search intent.


# Entity Layer
Source: https://docs.keupera.com/features/entity-layer

Profile how AI systems understand your brand's core data.

The **Entity Layer** (part of AI Studio) analyzes how well AI systems understand your business as a distinct, factual entity.

## The Concept

AI models rely on structured data, knowledge graphs, and clear, consistent facts to build their understanding of the world. The Entity Layer tools help you:

* **Audit Structured Data**: Check if your website's Schema markup correctly defines your organization, products, and services.
* **Consistency Checks**: Ensure your brand's name, description, and core facts are consistent across the web, making it easier for AI to piece the puzzle together.

## Campaigns & Scoring

By running an **Entity Campaign**, you receive an **Entity Score** that highlights issues like missing factual data or conflicting information that might confuse an AI attempting to summarize your brand.


# Focus Tools
Source: https://docs.keupera.com/features/focus-tools

Professional-grade SEO and AI utilities to supercharge your workflow.

The **Focus Tools** section provides a suite of specialized utilities categorized by SEO discipline:

## Keyword Research

* **Keyword Intent Checker**: Decode user intent behind queries.
* **Long-Tail Keyword Generator**: Discover high-opportunity, low-competition keywords.
* **Keyword Gap Analyzer**: See what you're missing vs competitors.
* **Search Volume Checker**: Get accurate monthly search estimates.

## Link Building

* **Outreach Email Generator**: Draft personalized link-building outreach emails.
* **Backlink Finder**: Find high-quality link opportunities.
* **Broken Link Checker**: Identify 404s to reclaim value.
* **Authority Checker**: Check domain and page strength.

## Writing & Content

* **Content Outline Generator**: Build publication-ready article outlines.
* **Title & Headline Generator**: Create click-worthy, SEO-optimized headlines.
* **Meta Description Generator**: Write compelling search-result summaries.
* **Article Rewriter & Optimizer**: Refresh existing content for better performance.

## Technical SEO

* **SEO Audit**: Identify technical issues instantly.
* **Sitemap Generator**: Create XML sitemaps for crawlers.
* **Robots.txt Generator**: Control crawler access effectively.
* **SSL Checker**: Verify security certificate validity.

## SERP & Utilities

* **SERP Previewer**: Visualize your snippet in search results.
* **Rich Snippet Generator**: Create schema markup easily.
* **Rank Tracker**: Monitor keyword positions over time.
* **Google Index Checker**: Verify URL indexing status.
* **URL Encoder/Decoder**, **Favicon Fetcher**, **WHOIS Lookup**, and **DNS Lookup**.


# Keywords
Source: https://docs.keupera.com/features/keywords

Discover and track high-value keywords for your website.

The **Keywords** feature empowers you to research, track, and optimize the search terms that matter most to your business.

## Researching Keywords

By entering a seed term or domain, you can generate comprehensive lists of relevant keywords. Each keyword includes critical data points:

* **Search Volume**: Monthly estimated searches.
* **Keyword Difficulty**: How hard it will be to rank for the term.
* **Search Intent**: Understanding whether the user is looking for information, navigating to a specific site, or ready to purchase.

## Tracking & Management

Keywords aren't just for research; Keupera allows you to track their performance over time:

* **Keyword Groups**: Organize terms logically based on topic or product category.
* **Funnel Stage**: Map keywords to the customer journey (Awareness, Consideration, Decision).
* **Enrichment**: Connect your tracked keywords directly to Google Search Console to see actual impressions and clicks.

## Actions

From the Keywords view, you can seamlessly push targets to the **Editor** to start creating optimized content, or assign them as **To-Do's** if you operate in Agency Mode.


# Prompt Engine
Source: https://docs.keupera.com/features/prompt-engine

Discover what users ask AI about your niche.

The **Prompt Engine** (part of AI Studio) is a revolutionary research tool that flips traditional keyword research on its head. Instead of looking at what people type into Google, it explores what questions users pose to conversational AI models.

## AI Prompt Research

Setting up a **Prompt Research Campaign** involves tracking specific topics or products. The engine discovers and clusters the exact prompts users are generating.

## Use Cases

* **Content Ideation**: Generate FAQ sections and deeply informative content based on the exact phrasing of complex AI queries.
* **Product Development**: Understand what users are actually trying to achieve and where they encounter friction with existing solutions.
* **Sales Enablement**: Prepare your team with answers to the nuanced questions prospects ask AI before speaking to a human.


# Welcome to Keupera
Source: https://docs.keupera.com/index

The AI-native SEO platform — programmatically access keyword research, backlinks, content, AI visibility, and analytics.

Keupera is an all-in-one SEO and AI visibility platform. The **Keupera Public API** lets you integrate every major module directly into your own tools and workflows. Those include Keyword Research, Backlink Research, Content Management, AI Visibility, and Analytics.

<Card title="Quickstart" icon="rocket" href="/quickstart">
  Make your first authenticated request in under 5 minutes.
</Card>

## API modules

<Columns>
  <Card title="Keywords" icon="magnifying-glass" href="/api-reference/keywords">
    Research, enrich, and manage keywords and keyword groups.
  </Card>

  <Card title="Backlinks" icon="link" href="/api-reference/backlinks">
    Run backlink campaigns, manage opportunities, and send outreach.
  </Card>

  <Card title="Content" icon="pen-to-square" href="/api-reference/content">
    Plan, generate, and publish AI-written blog articles.
  </Card>

  <Card title="AI Visibility" icon="robot" href="/api-reference/ai-visibility">
    Track brand mentions across LLMs with Brand Radar and Prompt Research.
  </Card>

  <Card title="Analytics" icon="chart-line" href="/api-reference/analytics">
    Website analytics, Search Console, and AI bot traffic.
  </Card>

  <Card title="API overview" icon="book-open" href="/api-reference/introduction">
    Base URL, authentication, pagination, and error handling.
  </Card>
</Columns>

## Get started

<Columns>
  <Card title="Generate an API key" icon="key" href="https://app.keupera.com">
    Create a key from **Settings → API Keys** in your Keupera dashboard.
  </Card>

  <Card title="Read the quickstart" icon="bolt" href="/quickstart">
    Authenticate and fetch your first dataset.
  </Card>
</Columns>

<Note>
  API access requires a subscription plan that includes the Public API. If you
  receive a `403`, upgrade your plan or contact [ask@support.keupera.com](mailto:ask@support.keupera.com).
</Note>


# Web analytics pixel
Source: https://docs.keupera.com/integrations/analytics-pixel

Install the cookieless Keupera tracker to power the Analytics module.

The Keupera tracker is a lightweight (under 2 KB), cookieless JavaScript snippet that streams pageviews into the [Analytics](/features/analytics) module. It populates the **Website** summary, daily traffic, top pages, referrers, devices, browsers, and geo breakdowns.

## How it works

* No cookies. A `keupera_session_id` is generated in `sessionStorage` and reset when the tab closes.
* Uses `navigator.sendBeacon` so the request never blocks navigation; falls back to `fetch` on older browsers.
* Captures URL, path, hostname, referrer, and UTM parameters automatically.
* Skips common sensitive paths (`/wp-admin`, `/wp-login`, `/admin`, `/.env`, `/.git`).

## Get your Tracking API key

<Steps>
  <Step title="Open API Keys">
    Go to **Account → API Keys** in your [dashboard](https://app.keupera.com).
  </Step>

  <Step title="Generate a 'Tracking' key">
    Click **Create API key** and choose the **Tracking** scope. Tracking keys are restricted — they can only send analytics events, never read or mutate other data, so it's safe to expose them in client-side HTML.
  </Step>
</Steps>

<Warning>
  Never embed a Full Access (`sk_live_...`) key in your website's HTML. Always use a **Tracking** scoped key for the pixel.
</Warning>

## Install on any website

Paste this snippet just before `</head>` on every page you want to track:

```html theme={null}
<!-- Keupera Analytics -->
<script>
  window.KEUPERA_API_KEY = "YOUR_TRACKING_API_KEY";
</script>
<script src="https://zone-2.cdn.keupera.com/public/scripts/analytics/tracker.js" async defer></script>
<!-- End Keupera Analytics -->
```

That's the whole install. The script self-initialises on `DOMContentLoaded` and fires a `pageview` event automatically.

## Platform-specific install

<AccordionGroup>
  <Accordion icon="wordpress" title="WordPress">
    Install the [Keupera Connector plugin](/integrations/wordpress). It injects the snippet into `wp_head` automatically when **Enable Website Analytics** is on (default). The plugin uses your Tracking key if provided, otherwise it falls back to the connected Full Access key.
  </Accordion>

  <Accordion icon="bolt" title="Framer">
    Install the **Keupera** plugin from the Framer marketplace and paste your Tracking key. The plugin handles the snippet injection.
  </Accordion>

  <Accordion icon="code" title="Next.js / React">
    Add the following to your root layout (`app/layout.tsx`). Set `NEXT_PUBLIC_KEUPERA_TRACKING_KEY` in your `.env.local`.

    ```html theme={null}
    <!-- Place in your root <head> -->
    <script>
      window.KEUPERA_API_KEY = process.env.NEXT_PUBLIC_KEUPERA_TRACKING_KEY;
    </script>
    <script
      src="https://zone-2.cdn.keupera.com/public/scripts/analytics/tracker.js"
      async
      defer
    ></script>
    ```

    Or use `next/script` — set `window.KEUPERA_API_KEY` in a `beforeInteractive` Script and load the tracker with `strategy="afterInteractive"`.
  </Accordion>

  <Accordion icon="globe" title="Webflow / Squarespace / Wix">
    Add the snippet in **Site Settings → Custom Code → Header**. The exact path varies per builder but every modern site builder supports a global `<head>` injection field.
  </Accordion>
</AccordionGroup>

## Custom events (optional)

After the tracker loads, `window.keupera.track(eventName, properties)` is available for custom events:

```js theme={null}
window.keupera?.track("signup_clicked", { plan: "pro" });
```

Custom events show up in the **Analytics → Events** view alongside pageviews.

## Verify the install

1. Open your live site in a new browser tab.
2. Open DevTools → **Network** and filter by `track`. You should see a `POST` to `https://sqnxgokfnvdglftrgekd.supabase.co/functions/v1/track` returning `204`.
3. In Keupera, open **Analytics → Website Summary**. New sessions appear within \~30 seconds.

If you see `Keupera Analytics: API Key not found` in the console, the `window.KEUPERA_API_KEY` assignment ran after the tracker — make sure the key `<script>` block sits **before** the tracker `<script>` tag.


# AI bot traffic tracker
Source: https://docs.keupera.com/integrations/bot-tracking

Capture AI crawler visits — GPTBot, ClaudeBot, PerplexityBot, and more.

AI assistants don't just answer from training data — they crawl the live web. The bot tracker tells you **which AI bots are reading your site, how often, and which pages they touch**. The data feeds the **Analytics → Bot Traffic** dashboard.

## Why a separate tracker?

The [JavaScript analytics pixel](/integrations/analytics-pixel) only fires when a real browser executes JS. Most AI crawlers fetch raw HTML and never run scripts, so they're invisible to client-side tracking. The bot tracker runs **server-side** (or via the WordPress plugin) and inspects the `User-Agent` of every request.

## Bots detected

| Bot                                 | Operator                   |
| ----------------------------------- | -------------------------- |
| GPTBot, ChatGPT-User, OAI-SearchBot | OpenAI                     |
| ClaudeBot, Claude-Web, Anthropic-ai | Anthropic                  |
| Google-Extended, Googlebot          | Google                     |
| PerplexityBot                       | Perplexity                 |
| Meta-ExternalAgent, FacebookBot     | Meta                       |
| Bytespider                          | ByteDance                  |
| Applebot-Extended                   | Apple                      |
| Cohere-ai                           | Cohere                     |
| YouBot                              | You.com                    |
| CCBot                               | Common Crawl               |
| Diffbot, Omgili                     | Other AI training crawlers |

The list is updated continuously as new agents appear.

## Enable it

<Steps>
  <Step title="Open the website settings">
    In the [Keupera dashboard](https://app.keupera.com) open **Settings → Website**.
  </Step>

  <Step title="Toggle 'Enable Bot Tracking' on">
    Flip the switch. Keupera now accepts bot events for this website.
  </Step>
</Steps>

## Install the collector

Pick whichever option matches your stack.

<AccordionGroup>
  <Accordion icon="wordpress" title="WordPress (recommended)">
    Install the [Keupera Connector plugin](/integrations/wordpress). It hooks `template_redirect`, inspects every frontend request's `User-Agent`, queues hits in a transient, and flushes them in batches of 10 (or every 5 minutes via WP-Cron, whichever comes first) to:

    ```
    POST https://app.keupera.com/api/v1/track-bot
    Authorization: Bearer <your API key>
    Content-Type: application/json

    { "events": [ { "bot_name": "GPTBot", "path": "/blog/post", "visit_date": "2026-05-08" } ] }
    ```

    No further setup — bot tracking starts automatically.
  </Accordion>

  <Accordion icon="server" title="Custom server / middleware">
    Detect known bot UAs in your edge layer (Cloudflare Workers, Vercel Middleware, Nginx, Express, etc.) and `POST` to `/api/v1/track-bot` with one or more events:

    ```bash theme={null}
    curl -X POST https://app.keupera.com/api/v1/track-bot \
      -H "Authorization: Bearer $KEUPERA_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "events": [
          { "bot_name": "GPTBot", "path": "/pricing", "visit_date": "2026-05-08" }
        ]
      }'
    ```

    Batch up to 50 events per call. The endpoint is idempotent on `(bot_name, path, visit_date)` — duplicates increment the visit counter rather than creating new rows.
  </Accordion>

  <Accordion icon="cloudflare" title="Cloudflare Worker (example)">
    ```js theme={null}
    const BOTS = /GPTBot|ClaudeBot|PerplexityBot|Google-Extended|Bytespider|CCBot|Anthropic-ai/i;

    export default {
      async fetch(req, env, ctx) {
        const ua = req.headers.get("user-agent") || "";
        const match = ua.match(BOTS);
        if (match) {
          ctx.waitUntil(
            fetch("https://app.keupera.com/api/v1/track-bot", {
              method: "POST",
              headers: {
                "Authorization": `Bearer ${env.KEUPERA_API_KEY}`,
                "Content-Type": "application/json",
              },
              body: JSON.stringify({
                events: [{
                  bot_name: match[0],
                  path: new URL(req.url).pathname,
                  visit_date: new Date().toISOString().slice(0, 10),
                }],
              }),
            })
          );
        }
        return fetch(req);
      },
    };
    ```
  </Accordion>
</AccordionGroup>

## Read the data

Bot data is exposed both in the dashboard and via the API:

| Endpoint                            | Returns                   |
| ----------------------------------- | ------------------------- |
| `GET /api/v1/bot-traffic/summary`   | Total visits per bot      |
| `GET /api/v1/bot-traffic/daily`     | Daily time-series per bot |
| `GET /api/v1/bot-traffic/top-pages` | Most-crawled paths        |

See the full schemas in the [Analytics API reference](/api-reference/analytics#bot-traffic).


# Google Search Console
Source: https://docs.keupera.com/integrations/google-search-console

Connect GSC to pull real keyword, click, and ranking data into Keupera.

Connecting **Google Search Console (GSC)** unlocks the most valuable data Keupera can give you: the actual queries Google sends to your site, with impressions, clicks, CTR, and average position. Once connected, Keupera uses GSC data to power:

* **Analytics → Search Console** views (daily stats, top keywords, top pages)
* **Striking distance** insights (keywords ranking 11–20 with high impressions)
* **Keyword cannibalisation** detection (multiple URLs competing for the same query)
* **Low-CTR opportunities** (high-impression pages with poor click-through)
* Real impressions and click counts on tracked keywords inside the [Keywords](/features/keywords) module.

## Prerequisites

* A verified property in [Google Search Console](https://search.google.com/search-console).
* The Google account you use to connect must have at least **Restricted** access to the property in GSC.

## Connect GSC

<Steps>
  <Step title="Open Settings → Integrations">
    Inside the [Keupera dashboard](https://app.keupera.com) navigate to **Settings → Integrations** for the website you want to connect.
  </Step>

  <Step title="Click 'Connect' under Google Search Console">
    The button redirects you through Google's OAuth consent screen. Keupera requests the read-only `webmasters.readonly` scope — it can read property data but never modify your GSC setup.

    <Note>
      The OAuth flow uses `access_type=offline` and `prompt=consent` so Google issues a refresh token. This lets Keupera continue syncing in the background even when you're logged out.
    </Note>
  </Step>

  <Step title="Pick the right property">
    After authorising, Keupera lists every GSC property the connected Google account can access. Choose the one matching the website you're configuring and click **Save**.
  </Step>
</Steps>

The first sync runs immediately and pulls the last 90 days of data. Subsequent syncs run automatically every 24 hours.

## What gets synced

| Data                                        | Source                            | Where you'll see it                    |
| ------------------------------------------- | --------------------------------- | -------------------------------------- |
| Daily clicks, impressions, CTR, position    | GSC `searchanalytics` API         | **Analytics → Search Console → Daily** |
| Top-performing queries                      | GSC dimension `query`             | **Analytics → Top Keywords**           |
| Top-performing pages                        | GSC dimension `page`              | **Analytics → Top Pages (GSC)**        |
| Per-keyword impressions/clicks              | Joined onto your tracked Keywords | **Keywords** table                     |
| Striking distance, cannibalisation, low CTR | Computed from GSC data            | **Analytics → SEO Insights**           |

## Permissions & privacy

* **Read-only** — Keupera only ever requests the `webmasters.readonly` scope.
* **Refresh tokens are encrypted** at rest in Keupera's database.
* You can disconnect at any time from **Settings → Integrations → Disconnect GSC**, which immediately revokes the token and stops future syncs. Already-synced historical data stays in your Keupera analytics.

## Troubleshooting

* **"No properties found"** — make sure the Google account you authorised has access to the property in GSC. Add the account in Search Console under **Settings → Users and permissions** if needed.
* **Data missing for the last 2–3 days** — Google delays GSC data by up to 72 hours. This is a Google-side limitation, not Keupera.
* **Sync errors after a Google password change** — refresh tokens can be invalidated. Re-run the **Connect** flow to issue a new one.

## API access

Once GSC is connected, the data is also available via the [Public API](/api-reference/analytics#search-console):

```http theme={null}
GET /api/v1/search-console/daily
GET /api/v1/search-console/keywords
GET /api/v1/search-console/pages
```


# n8n
Source: https://docs.keupera.com/integrations/n8n

Automate Keupera with the official n8n community node.

[n8n](https://n8n.io) is an open-source workflow automation tool. The official `n8n-nodes-keupera` community node lets you call every Keupera API module from inside a workflow, with credential management and auto-validated requests.

## Install the node

<Steps>
  <Step title="Open the n8n community nodes settings">
    In your n8n instance go to **Settings → Community Nodes** and click **Install a community node**.
  </Step>

  <Step title="Install `n8n-nodes-keupera`">
    Enter the package name:

    ```
    n8n-nodes-keupera
    ```

    Accept the risk prompt and click **Install**. n8n will pull it from npm and register the node.
  </Step>

  <Step title="Add the node to a workflow">
    Open any workflow, click the **+** button and search for **Keupera**. Add it as a step.
  </Step>
</Steps>

## Set up credentials

The node ships with a **Keupera API** credential type.

<Steps>
  <Step title="Generate a Keupera API key">
    In the [Keupera dashboard](https://app.keupera.com) go to **Account → API Keys** and click **Create API key**. Copy the `sk_live_...` value.
  </Step>

  <Step title="Create the credential in n8n">
    On the Keupera node, click **Credential to connect with → Create New**. Paste the key into the **API Key** field and save.

    n8n automatically verifies the key by calling `GET /me` against `https://app.keupera.com/api/v1`.
  </Step>
</Steps>

## Available resources

The node groups operations by API module, mirroring the [API reference](/api-reference/introduction):

| Resource          | Operations                                                                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **Keywords**      | List, Add, Delete, Toggle Star, Bulk Update Status, Trigger Research, Poll Research Job, List Groups                                           |
| **Backlinks**     | List Campaigns, Create Campaign, Get Campaign, List Opportunities, Get Recommendations, Get/Update Opportunity, Generate Email, Send Email     |
| **Content**       | List/Get/Create/Update/Delete Article, Trigger Generation, Get Calendar, Get/Update Automation                                                 |
| **AI Visibility** | Brand Radar (List/Create/Delete/Update/Results), Prompt Research (List/Create/Get), AI Score                                                   |
| **Analytics**     | Website (Summary/Daily/Top Pages/Referrers/Devices/Browsers/Geo), Search Console (Daily/Keywords/Pages), Bot Traffic (Summary/Daily/Top Pages) |
| **Utilities**     | Verify Credentials, Connect CMS, Track Bot Hit                                                                                                 |

The node can be used as an AI tool inside n8n's AI Agent nodes (`usableAsTool: true`), so an LLM agent can call Keupera operations directly.

## Example: auto-publish on keyword research completion

A common workflow:

1. **Schedule Trigger** → every weekday at 9am
2. **Keupera → Keywords → Trigger Research** with a seed keyword
3. **Wait** → 60 seconds
4. **Keupera → Keywords → Poll Research Job** → use the `job_id` from step 2
5. **IF** `status === "completed"` → continue, otherwise loop back to wait
6. **Keupera → Content → Create Article** using the top keyword as `keyword_id`
7. **Keupera → Content → Trigger Generation** on the new article

## Resources

* npm package: [`n8n-nodes-keupera`](https://www.npmjs.com/package/n8n-nodes-keupera)
* Source: [`github.com/keupera/n8n-nodes-keupera`](https://github.com/keupera/n8n-nodes-keupera)
* API reference: [Keupera Public API](/api-reference/introduction)


# Integrations
Source: https://docs.keupera.com/integrations/overview

Connect Keupera to your CMS, automation tools, and analytics stack.

Keupera works alongside the tools you already use. Plug it into your CMS to publish content automatically, wire it into automation platforms to build SEO workflows, or install a tracking pixel to feed real visitor and AI bot data back into your dashboard.

## Automation platforms

Trigger Keupera actions (publish an article, run keyword research, create a Brand Radar campaign) from any external workflow.

<CardGroup>
  <Card title="n8n" icon="diagram-project" href="/integrations/n8n">
    Official `n8n-nodes-keupera` community node with operations for every API module.
  </Card>

  <Card title="Zapier" icon="bolt" href="/integrations/zapier">
    Use the built-in **Webhooks by Zapier** action to call any Keupera endpoint.
  </Card>
</CardGroup>

## AI agents & assistants

Let Claude, Cursor, and other AI tools read and write your workspace directly through the Model Context Protocol — no copy-paste, no glue code.

<CardGroup>
  <Card title="MCP server" icon="plug" href="/mcp/introduction">
    Connect Claude, Claude Code, Cursor, VS Code, and any MCP client to Keupera.
  </Card>
</CardGroup>

## CMS connectors

Publish AI-written articles straight into your website with no copy-paste.

<CardGroup>
  <Card title="WordPress" icon="wordpress" href="/integrations/wordpress">
    Install the **Keupera Connector** plugin to publish articles, sync SEO meta, and track AI bots.
  </Card>
</CardGroup>

## Data sources

Feed Keupera the real-world traffic and search data it needs to give you accurate insights.

<CardGroup>
  <Card title="Web analytics pixel" icon="chart-line" href="/integrations/analytics-pixel">
    Install the lightweight, cookieless tracker to power the **Analytics** module.
  </Card>

  <Card title="AI bot traffic tracker" icon="robot" href="/integrations/bot-tracking">
    Capture visits from GPTBot, ClaudeBot, PerplexityBot, and more.
  </Card>

  <Card title="Google Search Console" icon="google" href="/integrations/google-search-console">
    Connect GSC to pull keywords, impressions, clicks, and rank data into Keupera.
  </Card>
</CardGroup>


# WordPress
Source: https://docs.keupera.com/integrations/wordpress

Publish Keupera articles directly to WordPress and track AI bots with the official Connector plugin.

The **Keupera Connector** is a free WordPress plugin that links your site to Keupera. Once installed, Keupera can publish AI-written articles into any post type, push SEO metadata to Yoast or Rank Math, inject the analytics tracking pixel, and capture AI bot visits server-side.

## What you get

* One-click site connection from the WordPress admin.
* Direct publishing of Keupera articles to **Posts**, **Pages**, or any custom post type.
* Automatic HTML → Gutenberg block conversion.
* Featured image and inline image sideloading.
* Yoast SEO and Rank Math metadata sync.
* Optional **SEO Toolbar** inside the Block Editor.
* Automatic injection of the [Keupera Analytics pixel](/integrations/analytics-pixel).
* Server-side [AI bot tracking](/integrations/bot-tracking) (catches bots that JavaScript pixels miss).

## Install the plugin

<Steps>
  <Step title="Download the plugin">
    Get the latest `keupera-connector.zip` from the [Keupera dashboard](https://app.keupera.com) under **Settings → Integrations → WordPress**.
  </Step>

  <Step title="Upload it to WordPress">
    In WordPress admin go to **Plugins → Add New → Upload Plugin**, choose the zip, and click **Install Now → Activate**.
  </Step>

  <Step title="Open the connector settings">
    On activation you're redirected to **Settings → Keupera Connector** automatically.
  </Step>
</Steps>

## Connect your site

<Steps>
  <Step title="Generate a Full Access API key">
    In the Keupera dashboard go to **Account → API Keys → Create API key** and copy the `sk_live_...` value.
  </Step>

  <Step title="Paste it into the plugin">
    Paste the key into the **Keupera API Key (Full Access)** field and click **Connect Site**.

    The plugin calls `POST /api/v1/connect` with `{ "type": "wordpress", "site_url": "<your site>", "username": "<admin>", "app_password": "..." }` and stores the returned `website_id` locally.
  </Step>

  <Step title="(Optional) Add a Tracking Key">
    Connecting automatically provisions a restricted **Tracking** key used only by the analytics pixel. You can also paste a manually generated tracking key under **Tracking API Key (Optional)**.
  </Step>
</Steps>

Once connected you'll see **✅ Protected & Connected** along with your Website ID. Use **Disconnect / Reset Key** to rotate.

## Publishing settings

| Setting                      | Default | Purpose                                                                                                                                                                                |
| ---------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Default Post Type**        | `post`  | Which CPT Keupera publishes into. Lists every public post type registered on your site, with its supported features (title, editor, thumbnail, excerpt, custom-fields) and taxonomies. |
| **Enable SEO Toolbar**       | On      | Adds a Keupera SEO sidebar inside the Gutenberg editor for real-time analysis.                                                                                                         |
| **Enable Website Analytics** | On      | Auto-injects the Keupera tracking pixel into `wp_head`. Cookieless — uses `sessionStorage` only.                                                                                       |

## How publishing works

When Keupera publishes an article, the plugin's REST route `POST /wp-json/keupera/v1/publish` runs:

1. **Auth** — Application Password (Basic Auth) or fallback `X-Keupera-Authorization` header for hosts that strip the standard header.
2. **Create post** — `wp_insert_post` with the configured post type, title, content, and excerpt.
3. **HTML → blocks** — Converts headings, lists, blockquotes, code, images, tables, and figures into Gutenberg blocks so editors don't see "Classic Block" fallbacks.
4. **Metadata** — Applies `meta_input` and ACF fields if the ACF plugin is active.
5. **Taxonomies** — Accepts terms by ID, slug, or name; auto-creates missing terms (e.g. tags).
6. **SEO** — Writes meta title, description, and focus keyword to Yoast or Rank Math when present.
7. **Images** — Sideloads remote images (featured image and any `<img src>` in the body) into the WordPress Media Library, rewrites URLs, and rebuilds image blocks with proper attributes.

## Connector REST endpoints

The plugin registers a `keupera/v1` REST namespace for Keupera to use:

| Method | Path                                           | Purpose                                                  |
| ------ | ---------------------------------------------- | -------------------------------------------------------- |
| `POST` | `/wp-json/keupera/v1/publish`                  | Create a post with full SEO + media pipeline.            |
| `GET`  | `/wp-json/keupera/v1/post-types`               | Discover available CPTs, their supports, and taxonomies. |
| `GET`  | `/wp-json/keupera/v1/taxonomies?post_type=...` | Discover taxonomies for a CPT.                           |
| `GET`  | `/wp-json/keupera/v1/terms?taxonomy=...`       | List terms inside a taxonomy.                            |

All four routes require an authenticated WordPress user with `edit_posts` for the requested CPT.

## Troubleshooting

* **"Permission denied" on publish** — your host is stripping the `Authorization` header. The plugin falls back to `X-Keupera-Authorization`; if that also fails, open a support ticket.
* **Posts published as "Classic Block"** — make sure your content is under 1 MB; the block converter uses `DOMDocument` which is included by default in PHP but disabled in some hardened environments.
* **Debug log** — check `wp-content/uploads/keupera-debug.log` or scroll to the bottom of the connector settings page; the log viewer is rendered there if the file exists.

## Resources

* Plugin source: see `keupera-wp-plugin/` in the Keupera repo.
* Related: [Web analytics pixel](/integrations/analytics-pixel) · [Bot tracking](/integrations/bot-tracking)


# Zapier
Source: https://docs.keupera.com/integrations/zapier

Call Keupera from any Zap using Webhooks by Zapier.

Keupera exposes a clean REST API, so any Zap can talk to it through the built-in **Webhooks by Zapier** action. No custom integration required.

<Note>
  A native Zapier app is on the roadmap. Until then, the recipes below cover every Keupera endpoint.
</Note>

## Prerequisites

* A Zapier account on any plan that supports **Webhooks by Zapier** (Starter and above).
* A Keupera API key from **Account → API Keys** in your [dashboard](https://app.keupera.com).

## Generic setup

Every Zap that calls Keupera uses the same basic action.

<Steps>
  <Step title="Add a 'Webhooks by Zapier' action">
    In your Zap editor, add an action and choose **Webhooks by Zapier**.
  </Step>

  <Step title="Pick the right event">
    * `GET` for read operations (list keywords, fetch analytics, etc.)
    * `POST` to create resources or trigger jobs
    * `PATCH` to update records
    * `DELETE` to remove records (use **Custom Request**)
  </Step>

  <Step title="Configure the request">
    * **URL**: `https://app.keupera.com/api/v1/<endpoint>`
    * **Data Pass-Through**: `false`
    * **Headers**:
      * `Authorization`: `Bearer sk_live_xxxxxxxxxxxxxxxx`
      * `Content-Type`: `application/json`
    * **Data** (for POST/PATCH): JSON body for the endpoint
  </Step>

  <Step title="Test the step">
    Zapier shows the JSON response so you can map fields into downstream steps.
  </Step>
</Steps>

<Warning>
  Store the API key in Zapier's **Storage** or paste it once into the action — never expose `sk_live_...` keys in client-side code.
</Warning>

## Recipe: Add a keyword from a Google Sheet row

| Step | App                | Configuration                                                                                                                                               |
| ---- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1    | Google Sheets      | **New Spreadsheet Row** trigger                                                                                                                             |
| 2    | Webhooks by Zapier | **POST** to `https://app.keupera.com/api/v1/keywords` with body `{ "keywords": [{ "term": "{{Keyword}}", "keyword_group": "{{Group}}" }], "enrich": true }` |

## Recipe: Notify Slack when a Brand Radar campaign finishes

| Step | App                | Configuration                                                                                  |
| ---- | ------------------ | ---------------------------------------------------------------------------------------------- |
| 1    | Schedule by Zapier | Every hour                                                                                     |
| 2    | Webhooks by Zapier | **GET** `https://app.keupera.com/api/v1/brand-radar/campaigns/{{campaign_id}}/results?limit=1` |
| 3    | Filter by Zapier   | Only continue if `data[0].run_at` is newer than the last seen timestamp                        |
| 4    | Slack              | **Send Channel Message** with the visibility score and mentions                                |

## Recipe: Publish a draft article when a Trello card moves

| Step | App                | Configuration                                                                                                             |
| ---- | ------------------ | ------------------------------------------------------------------------------------------------------------------------- |
| 1    | Trello             | **Card Moved to List** trigger (list = "Ready to publish")                                                                |
| 2    | Webhooks by Zapier | **PATCH** `https://app.keupera.com/api/v1/articles/{{Card Description Article ID}}` with body `{ "status": "published" }` |

## Errors & retries

Keupera returns standard HTTP codes (`401`, `402`, `403`, `404`, `500`) with a JSON `{ "error": "..." }` body. Zapier will surface the error message; for `402 Payment Required` (usage limit reached) enable metered billing in **Account → Billing → Usage**.

See the full [API reference](/api-reference/introduction) for every endpoint, request shape, and response example.


# Antigravity
Source: https://docs.keupera.com/mcp/antigravity

Connect Keupera to Antigravity as an MCP server.

[Antigravity](https://antigravity.google) connects to the Keupera MCP server
over HTTP. Authorize with OAuth (browser sign-in) or an API key.

## Add the server

<Steps>
  <Step title="Open MCP settings">
    Open the **Agent panel → MCP servers → Add server** — or edit the MCP config
    directly:

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "serverUrl": "https://mcp.keupera.com/mcp" }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Connect **keupera** and sign in to Keupera in the browser when prompted. To
    use an API key instead, add `"headers": { "Authorization": "Bearer
            sk_live_your_key" }`.
  </Step>
</Steps>

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Confirm `keupera` is connected in the MCP servers panel, then ask, for example:
*"List my tracked keywords by opportunity and draft an article for the top one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server won't connect">
    Confirm the config uses `serverUrl` with the exact URL
    `https://mcp.keupera.com/mcp`. Reopen the MCP servers panel to reconnect.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, reconnect and sign in again. For an API key, confirm the
    `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Authentication
Source: https://docs.keupera.com/mcp/authentication

How the Keupera MCP server authenticates clients — OAuth sign-in and API keys — and what access a connected app gets.

The Keupera MCP server accepts two credential types on the same endpoint
(`https://mcp.keupera.com/mcp`). Both act as **you** against your workspace.

| Method                           | Best for                                           | Setup                           |
| -------------------------------- | -------------------------------------------------- | ------------------------------- |
| **Sign in with Keupera (OAuth)** | Claude, Claude Code, Cursor, desktop & web clients | None — the client runs the flow |
| **API key** (`sk_live_…`)        | Scripts, servers, headless / CI                    | Create a key in the dashboard   |

## Sign in with Keupera (OAuth)

When your client connects, it sends you to Keupera to sign in and approve access:

<Steps>
  <Step title="Your client opens Keupera">
    The MCP client (Claude, Cursor, …) opens a browser to the Keupera sign-in.
  </Step>

  <Step title="Review the consent screen">
    You'll see which app is requesting access, whether it's **verified**, the
    domain you'll be returned to, and what it can do. Approve only apps you
    started yourself.
  </Step>

  <Step title="You're connected">
    Keupera issues the client a token. The client stores it securely and
    refreshes it automatically — you won't be asked again until you revoke it.
  </Step>
</Steps>

<Warning>
  Third-party apps that aren't on Keupera's verified list show an **"Unverified
  third-party app"** notice on the consent screen. That's normal for most
  clients — but never approve a request you didn't initiate.
</Warning>

There's nothing to configure on your side: no client IDs, no secrets. Your
client handles registration and the PKCE flow automatically.

## API key

For non-interactive use, send your key as a bearer token:

```
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx
```

Create and manage keys under **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

<Warning>
  Treat API keys like passwords. Never embed one in a browser or client-side
  app — keep it server-side. Revoke a leaked key from **Settings → API Keys**.
</Warning>

## What a connected app can do

A connected client acts with your account's permissions and is subject to the
same plan quotas (`crawl_credits`, `ai_credits`, …) as the dashboard. It can
read your data and, unless restricted, create and update keywords, content,
backlinks, and campaigns.

<Note>
  Depending on your workspace settings, **OAuth-connected apps may be limited**
  to reading and writing, with **deleting and sending outreach email disabled**.
  Personal API keys are never restricted. Ask your workspace owner if an action
  is blocked.
</Note>

## Revoke access

* **OAuth apps:** **Account → Developer → Connected apps** in the dashboard —
  click **Revoke** on any app. This invalidates its tokens immediately.
* **API keys:** **Settings → API Keys** → revoke the key.
* **From the client:** most clients also let you disconnect (e.g. Claude Code
  `/mcp → Clear authentication`, or remove the connector in claude.ai).


# ChatGPT
Source: https://docs.keupera.com/mcp/chatgpt

Add Keupera to ChatGPT with the one-click app or a custom connector.

Connect Keupera to [ChatGPT](https://chatgpt.com) to run research and content
workflows in chat. Use the one-click Keupera app, or add a custom connector.

## Option A — Keupera ChatGPT App (one click)

Add the **Keupera ChatGPT App** to render interactive dashboards directly in
chat. It handles authentication for you — just sign in to Keupera when prompted.

## Option B — Custom connector

Available on **ChatGPT Plus, Pro, and Business**.

<Steps>
  <Step title="Enable developer mode">
    Go to **Settings → Connectors → Advanced** and turn on **Developer mode**.
  </Step>

  <Step title="Add the connector">
    In **Connectors → Create**, name it `Keupera` with URL
    `https://mcp.keupera.com/mcp`.
  </Step>

  <Step title="Sign in">
    Authorize Keupera in the browser, then enable the connector in your chat's
    tools.
  </Step>
</Steps>

## Use it

Ask ChatGPT naturally, for example:

* *"Research keywords for 'vegan protein powder' and add the best 10 to tracking."*
* *"How visible is my brand in ChatGPT and Perplexity this month?"*
* *"Draft an article for my top-opportunity keyword and schedule it for Monday."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Can't add a custom connector">
    Custom connectors require a Plus, Pro, or Business plan and **Developer
    mode** enabled under Settings → Connectors → Advanced.
  </Accordion>

  <Accordion title="Tools don't appear in chat">
    After connecting, enable Keupera in the chat's tools/connectors menu. Confirm
    the URL is exactly `https://mcp.keupera.com/mcp`.
  </Accordion>
</AccordionGroup>


# Claude.ai & Claude Desktop
Source: https://docs.keupera.com/mcp/claude

Add Keupera as a custom connector in Claude on the web or desktop.

Connect Keupera to Claude on [claude.ai](https://claude.ai) or the Claude
Desktop app as a **custom connector**. You authorize with your Keupera account
in the browser — no API key needed.

## Add the connector

<Steps>
  <Step title="Open connector settings">
    In Claude, go to **Settings → Connectors** and click **Add custom
    connector**.
  </Step>

  <Step title="Enter the Keupera server">
    * **Name:** `Keupera`
    * **URL:** `https://mcp.keupera.com/mcp`

    Then click **Add**.
  </Step>

  <Step title="Connect and authorize">
    Click **Connect**. A browser window opens to sign in to Keupera and an
    **Authorize access** screen — click **Allow**. Claude returns to the
    connector, now showing the Keupera tools.
  </Step>
</Steps>

<Note>
  Custom connectors call your MCP server from Anthropic's cloud, so the
  connection works the same on web and desktop. Your access is stored securely
  by Claude and refreshed automatically.
</Note>

## Use it

Ask Claude naturally, for example:

* *"Research keywords for 'vegan protein powder' and add the best 10 to tracking."*
* *"How visible is my brand in ChatGPT and Perplexity this month?"*
* *"Draft an article for my top-opportunity keyword and schedule it for Monday."*

## Manage access

* **Disconnect:** Settings → Connectors → Keupera → remove.
* **Revoke from Keupera:** **Account → Developer → Connected apps** in the dashboard.

## Troubleshooting

<AccordionGroup>
  <Accordion title="The tools don't appear after connecting">
    Re-open Settings → Connectors and confirm Keupera shows as connected. If not,
    remove it and add it again, making sure the URL is exactly
    `https://mcp.keupera.com/mcp`.
  </Accordion>

  <Accordion title="Authorization window closes without connecting">
    Make sure you completed the Keupera sign-in and clicked **Allow** on the
    consent screen. Pop-up blockers can interrupt the flow — allow pop-ups for
    claude.ai and retry.
  </Accordion>
</AccordionGroup>


# Claude Code
Source: https://docs.keupera.com/mcp/claude-code

Connect Keupera to the Claude Code CLI with OAuth or an API key.

[Claude Code](https://code.claude.com) connects to the Keupera MCP server over
HTTP. Use OAuth to sign in via the browser, or an API key for a headless setup.

<Note>
  Requires a recent Claude Code. Run `claude --version`; if `/mcp` is missing,
  update first.
</Note>

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    ```bash theme={null}
    claude mcp add --transport http keupera https://mcp.keupera.com/mcp -s user
    ```

    `-s user` makes Keupera available in every project. Drop it to add it only
    to the current project.
  </Step>

  <Step title="Authorize">
    Start Claude Code and run:

    ```
    /mcp
    ```

    Select **keupera → Authenticate**. Your browser opens to sign in to Keupera
    and **Allow** access. Claude Code stores the token and refreshes it
    automatically.
  </Step>
</Steps>

## Option B — API key

```bash theme={null}
claude mcp add --transport http keupera https://mcp.keupera.com/mcp \
  --header "Authorization: Bearer sk_live_your_key" \
  -s user
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Run `/mcp` to confirm `keupera` is connected, then ask, for example:
*"List my tracked keywords by opportunity and draft an article for the top one."*

To disconnect: `/mcp → keupera → Clear authentication`, or
`claude mcp remove keupera`.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication doesn't start / tools missing">
    Run `/mcp` and select **Authenticate** again. If it still fails, remove and
    re-add the server: `claude mcp remove keupera` then repeat the add command.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    Your session or key is invalid. For OAuth, re-run `/mcp → Authenticate`. For
    an API key, confirm the `sk_live_…` value and that your plan includes API
    access.
  </Accordion>
</AccordionGroup>


# All clients
Source: https://docs.keupera.com/mcp/clients

Step-by-step setup for every MCP client: CLI agents, web chat clients and IDEs.

The Keupera MCP server works with any client that speaks **remote (Streamable
HTTP) MCP**. Point it at the endpoint below and authenticate with OAuth (browser
sign-in) or an API key.

```text Server URL theme={null}
https://mcp.keupera.com/mcp
```

<Note>
  On first connect, your client opens a browser to **sign in to Keupera**
  (OAuth), so there's no key to copy. Prefer a key? Add
  `Authorization: Bearer sk_live_…` and generate one under **Account → API Keys**
  in the [dashboard](https://app.keupera.com).
</Note>

## Pick your client

<Tabs>
  <Tab title="AI Agent CLI">
    <AccordionGroup>
      <Accordion title="Claude Code">
        **1. Add the server** (drop `-s user` to scope to the current project):

        ```bash theme={null}
        claude mcp add --transport http keupera https://mcp.keupera.com/mcp -s user
        ```

        **2. Authenticate:** start Claude Code, run `/mcp`, select **keupera → Authenticate**, and Allow access in the browser.

        Use an API key instead:

        ```bash theme={null}
        claude mcp add --transport http keupera https://mcp.keupera.com/mcp \
          --header "Authorization: Bearer sk_live_your_key" -s user
        ```

        [Full Claude Code guide →](/mcp/claude-code)
      </Accordion>

      <Accordion title="Codex (OpenAI)">
        Codex speaks stdio, so bridge to the hosted server with `mcp-remote`. Add to `~/.codex/config.toml`:

        ```toml theme={null}
        [mcp_servers.keupera]
        command = "npx"
        args = ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"]
        ```

        Start Codex, and `mcp-remote` opens the browser to authorize Keupera on first use.

        Use an API key instead:

        ```toml theme={null}
        [mcp_servers.keupera]
        command = "npx"
        args = ["-y", "mcp-remote", "https://mcp.keupera.com/mcp", "--header", "Authorization: Bearer sk_live_your_key"]
        ```

        [Full Codex guide →](/mcp/codex)
      </Accordion>

      <Accordion title="Gemini CLI">
        Add to `~/.gemini/settings.json` (native Streamable-HTTP support):

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "httpUrl": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Run `gemini`, then `/mcp` to confirm and sign in when prompted.

        Use an API key instead: add `"headers": { "Authorization": "Bearer sk_live_your_key" }`.

        [Full Gemini CLI guide →](/mcp/gemini-cli)
      </Accordion>

      <Accordion title="GitHub Copilot CLI">
        Register an HTTP MCP server (run `/mcp` in the Copilot CLI, or add to your Copilot MCP config):

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Run `/mcp` to connect **keupera** and authorize in the browser.

        [Full GitHub Copilot CLI guide →](/mcp/copilot-cli)
      </Accordion>

      <Accordion title="OpenCode">
        Add a remote server to `opencode.json` (project or `~/.config/opencode/opencode.json`):

        ```json theme={null}
        {
          "$schema": "https://opencode.ai/config.json",
          "mcp": {
            "keupera": { "type": "remote", "url": "https://mcp.keupera.com/mcp", "enabled": true }
          }
        }
        ```

        Start OpenCode and sign in when prompted. For an API key, add `"headers": { "Authorization": "Bearer sk_live_your_key" }`.
        [Full OpenCode guide →](/mcp/opencode)
      </Accordion>

      <Accordion title="Factory (Droid)">
        Add an HTTP MCP server to `~/.factory/mcp.json`:

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Run `droid`, open the MCP panel, connect **keupera**, and sign in.

        [Full Factory (Droid) guide →](/mcp/factory)
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Web Clients">
    <AccordionGroup>
      <Accordion title="Claude.ai & Claude Desktop">
        <Steps>
          <Step title="Open connector settings">Settings → **Connectors** → **Add custom connector**.</Step>
          <Step title="Enter the server">Name it `Keupera`, URL `https://mcp.keupera.com/mcp`, click **Add**.</Step>
          <Step title="Connect & authorize">Click **Connect**, sign in to Keupera and **Allow**. Works the same on web and desktop.</Step>
        </Steps>

        [Full Claude.ai & Desktop guide →](/mcp/claude)
      </Accordion>

      <Accordion title="ChatGPT">
        **One click:** add the Keupera ChatGPT App to render interactive dashboards in chat.

        **Or add a custom connector** (ChatGPT Plus / Pro / Business):

        <Steps>
          <Step title="Enable developer mode">Settings → Connectors → Advanced → **Developer mode**.</Step>
          <Step title="Add the connector">Connectors → **Create**, name it `Keupera`, URL `https://mcp.keupera.com/mcp`.</Step>
          <Step title="Sign in">Authorize Keupera in the browser, then enable it in your chat's tools.</Step>
        </Steps>

        [Full ChatGPT guide →](/mcp/chatgpt)
      </Accordion>

      <Accordion title="Goose">
        <Steps>
          <Step title="Add an extension">Goose Desktop → Settings → Extensions → **Add** (or `goose configure` → Add Extension).</Step>
          <Step title="Choose Streamable HTTP">Pick **Remote Extension (Streamable HTTP)**, endpoint `https://mcp.keupera.com/mcp`.</Step>
          <Step title="Authorize">Sign in to Keupera in the browser when prompted.</Step>
        </Steps>

        [Full Goose guide →](/mcp/goose)
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="IDE">
    <AccordionGroup>
      <Accordion title="Cursor">
        Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (per-project):

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "url": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Then **Settings → MCP → Keupera → Login** and sign in. For an API key, add `"headers": { "Authorization": "Bearer sk_live_your_key" }`.
        [Full Cursor guide →](/mcp/cursor)
      </Accordion>

      <Accordion title="VS Code (GitHub Copilot)">
        Create `.vscode/mcp.json`:

        ```json theme={null}
        {
          "servers": {
            "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Or from the CLI:

        ```bash theme={null}
        code --add-mcp '{"name":"keupera","type":"http","url":"https://mcp.keupera.com/mcp"}'
        ```

        Start **keupera** in the Copilot Chat MCP view and sign in.

        [Full VS Code guide →](/mcp/vscode)
      </Accordion>

      <Accordion title="Antigravity">
        Open the **Agent panel → MCP servers → Add server**, or edit the MCP config:

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "serverUrl": "https://mcp.keupera.com/mcp" }
          }
        }
        ```

        Connect **keupera** and sign in when prompted.

        [Full Antigravity guide →](/mcp/antigravity)
      </Accordion>

      <Accordion title="Kiro">
        Edit `.kiro/settings/mcp.json` (workspace) or `~/.kiro/settings/mcp.json` (user):

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"] }
          }
        }
        ```

        Kiro reloads MCP servers automatically; `mcp-remote` opens the browser to sign in.
        [Full Kiro guide →](/mcp/kiro)
      </Accordion>

      <Accordion title="Windsurf">
        Edit `~/.codeium/windsurf/mcp_config.json` (Windsurf proxies HTTP servers via `mcp-remote`):

        ```json theme={null}
        {
          "mcpServers": {
            "keupera": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"] }
          }
        }
        ```

        Click **Refresh** in the MCP panel and sign in to Keupera on first connect.
        [Full Windsurf guide →](/mcp/windsurf)
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>

<Note>
  Not listed? Any client that supports remote HTTP MCP works. Add a server with
  URL `https://mcp.keupera.com/mcp`. For stdio-only clients, bridge with
  `npx -y mcp-remote https://mcp.keupera.com/mcp`.
</Note>

See the [tool reference](/mcp/tools) for everything you can do once connected.


# Codex (OpenAI)
Source: https://docs.keupera.com/mcp/codex

Connect Keupera to OpenAI Codex via the mcp-remote bridge.

[Codex](https://openai.com/codex) speaks **stdio** MCP, so it connects to the
hosted Keupera server through the `mcp-remote` bridge. Authorize with OAuth
(browser sign-in) or an API key.

<Note>
  `mcp-remote` runs via `npx`, so you need Node.js installed. No global install
  is required.
</Note>

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Add Keupera to `~/.codex/config.toml`:

    ```toml theme={null}
    [mcp_servers.keupera]
    command = "npx"
    args = ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"]
    ```
  </Step>

  <Step title="Authorize">
    Start Codex. On first use, `mcp-remote` opens your browser to sign in to
    Keupera and **Allow** access. The token is cached and refreshed
    automatically.
  </Step>
</Steps>

## Option B — API key

```toml theme={null}
[mcp_servers.keupera]
command = "npx"
args = ["-y", "mcp-remote", "https://mcp.keupera.com/mcp", "--header", "Authorization: Bearer sk_live_your_key"]
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Restart Codex and confirm the `keupera` tools are listed, then ask, for example:
*"List my tracked keywords by opportunity and draft an article for the top one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Tools don't appear / server won't start">
    Confirm Node.js is installed (`node --version`) and that the TOML block is
    valid. Restart Codex to reload the config.
  </Accordion>

  <Accordion title="Browser sign-in doesn't open">
    Clear the cached auth and retry: delete the `mcp-remote` cache in
    `~/.mcp-auth` (or the path printed on startup), then restart Codex.
  </Accordion>
</AccordionGroup>


# GitHub Copilot CLI
Source: https://docs.keupera.com/mcp/copilot-cli

Connect Keupera to the GitHub Copilot CLI as an HTTP MCP server.

The [GitHub Copilot CLI](https://docs.github.com/copilot) connects to the
Keupera MCP server over **HTTP**. Authorize with OAuth (browser sign-in) or an
API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Register an HTTP MCP server in your Copilot MCP config:

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Run `/mcp` in the Copilot CLI to connect **keupera**, then authorize Keupera
    in the browser when prompted.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "type": "http",
      "url": "https://mcp.keupera.com/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Run `/mcp` to confirm `keupera` is connected, then ask, for example:
*"List my tracked keywords by opportunity and draft an article for the top one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server won't connect">
    Confirm the config is valid JSON with `"type": "http"` and the exact URL
    `https://mcp.keupera.com/mcp`. Re-run `/mcp` to reconnect.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, reconnect via `/mcp` and sign in again. For an API key, confirm
    the `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Cursor
Source: https://docs.keupera.com/mcp/cursor

Connect Keupera to the Cursor editor as an MCP server.

[Cursor](https://cursor.com) connects to the Keupera MCP server over HTTP.
Authorize with OAuth (browser sign-in) or an API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Add Keupera to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json`
    (per-project):

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "url": "https://mcp.keupera.com/mcp" }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Go to **Settings → MCP → Keupera → Login** and sign in to Keupera in the
    browser.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "url": "https://mcp.keupera.com/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

In **Settings → MCP**, confirm `keupera` shows as connected, then ask, for
example: *"List my tracked keywords by opportunity and draft an article for the
top one."*

[Cursor MCP docs →](https://docs.cursor.com/context/mcp)

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server not listed">
    Confirm `mcp.json` is valid JSON and the URL is exactly
    `https://mcp.keupera.com/mcp`. Reopen Settings → MCP to reload.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, click **Login** again under Settings → MCP → Keupera. For an API
    key, confirm the `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Factory (Droid)
Source: https://docs.keupera.com/mcp/factory

Connect Keupera to Factory's Droid agent as an HTTP MCP server.

[Factory](https://factory.ai) connects its **Droid** agent to the Keupera MCP
server over **HTTP**. Authorize with OAuth (browser sign-in) or an API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Add an HTTP MCP server to `~/.factory/mcp.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Run `droid`, open the MCP panel, connect **keupera**, and sign in to Keupera
    in the browser when prompted.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "type": "http",
      "url": "https://mcp.keupera.com/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Open the MCP panel and confirm `keupera` is connected, then ask, for example:
*"List my tracked keywords by opportunity and draft an article for the top one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server won't connect">
    Confirm `~/.factory/mcp.json` is valid JSON with `"type": "http"` and the
    exact URL. Reopen the MCP panel to reconnect.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, reconnect and sign in again. For an API key, confirm the
    `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Gemini CLI
Source: https://docs.keupera.com/mcp/gemini-cli

Connect Keupera to the Gemini CLI over native Streamable HTTP.

The [Gemini CLI](https://github.com/google-gemini/gemini-cli) has native
**Streamable HTTP** support, so it connects to the Keupera MCP server directly —
no bridge needed. Authorize with OAuth (browser sign-in) or an API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Add Keupera to `~/.gemini/settings.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "httpUrl": "https://mcp.keupera.com/mcp" }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Run `gemini`, then `/mcp` to confirm the server and sign in to Keupera in the
    browser when prompted.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "httpUrl": "https://mcp.keupera.com/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Run `/mcp` to confirm `keupera` is connected, then ask, for example:
*"Show my top keyword opportunities and outline an article for the best one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server not listed after editing settings">
    Ensure `settings.json` is valid JSON and uses `httpUrl` (not `url`). Restart
    the Gemini CLI to reload.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, re-run `/mcp` and sign in again. For an API key, confirm the
    `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Goose
Source: https://docs.keupera.com/mcp/goose

Connect Keupera to Goose as a Streamable HTTP extension.

[Goose](https://block.github.io/goose) connects to the Keupera MCP server as a
**Streamable HTTP extension**. Authorize with OAuth (browser sign-in) or an API
key.

## Add the extension

<Steps>
  <Step title="Open extension settings">
    In Goose Desktop, go to **Settings → Extensions → Add** — or run
    `goose configure` and choose **Add Extension** in the terminal.
  </Step>

  <Step title="Choose Streamable HTTP">
    Pick **Remote Extension (Streamable HTTP)** and enter the endpoint
    `https://mcp.keupera.com/mcp`.
  </Step>

  <Step title="Authorize">
    Sign in to Keupera in the browser when prompted. To use an API key instead,
    add an `Authorization: Bearer sk_live_your_key` header.
  </Step>
</Steps>

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Use it

Confirm the Keupera extension is enabled, then ask, for example:
*"Show my top keyword opportunities and outline an article for the best one."*

[Goose extensions docs →](https://block.github.io/goose/docs/getting-started/using-extensions)

## Troubleshooting

<AccordionGroup>
  <Accordion title="Extension won't connect">
    Confirm you selected **Remote Extension (Streamable HTTP)** and the endpoint
    is exactly `https://mcp.keupera.com/mcp`. Toggle the extension off and on to
    reconnect.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, re-authorize from the extension settings. For an API key, confirm
    the `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# MCP Server
Source: https://docs.keupera.com/mcp/introduction

Connect AI agents and IDEs to your Keupera workspace over the Model Context Protocol.

The **Keupera MCP server** exposes the Keupera Public API as [Model Context
Protocol](https://modelcontextprotocol.io) tools, so AI agents and IDEs —
Claude, Claude Code, Cursor, VS Code, Windsurf, and any MCP-capable client — can
read and write your Keupera workspace directly: tracked keywords, backlinks,
content, analytics, Search Console, and AI-visibility (Brand Radar).

## Endpoint

```
https://mcp.keupera.com/mcp
```

Transport is **Streamable HTTP**. The same endpoint serves every client.

## Authentication

You can connect in one of two ways — both map to the same workspace:

<CardGroup>
  <Card title="Sign in with Keupera (OAuth)" icon="key">
    Authorize in the browser, no key to copy. Best for desktop and web clients.
  </Card>

  <Card title="API key" icon="lock">
    Send your `sk_live_…` key as a Bearer token. Best for scripts and headless setups.
  </Card>
</CardGroup>

Generate API keys from **Settings → API Keys** in your
[Keupera dashboard](https://app.keupera.com). OAuth requires no setup on your
side — your client walks you through it.

## Connect your client

Pick your tool for step-by-step instructions. **[All clients](/mcp/clients)**
covers every supported CLI agent, web chat client and IDE — Claude Code, Codex,
Gemini CLI, GitHub Copilot, OpenCode, Factory, Claude.ai, ChatGPT, Goose,
Cursor, VS Code, Antigravity, Kiro and Windsurf.

<CardGroup>
  <Card title="All clients" icon="plug" href="/mcp/clients">
    Grouped, step-by-step setup for every CLI, web client and IDE.
  </Card>

  <Card title="Claude.ai & Desktop" icon="comment" href="/mcp/claude" />

  <Card title="Claude Code" icon="terminal" href="/mcp/claude-code" />

  <Card title="Other clients" icon="plug" href="/mcp/other-clients" />
</CardGroup>

## What you can do

Once connected, your assistant can run keyword research, draft and schedule
articles, build backlink campaigns and outreach, pull analytics and Search
Console data, and track AI-visibility across LLMs. See the full
[tool reference](/mcp/tools).

<Note>
  All actions run as **you** and respect your plan's quotas and permissions,
  exactly as if you performed them in the dashboard.
</Note>


# Kiro
Source: https://docs.keupera.com/mcp/kiro

Connect Keupera to Kiro via the mcp-remote bridge.

[Kiro](https://kiro.dev) connects to the hosted Keupera MCP server through the
`mcp-remote` bridge. Authorize with OAuth (browser sign-in) or an API key.

<Note>
  `mcp-remote` runs via `npx`, so you need Node.js installed. No global install
  is required.
</Note>

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Edit `.kiro/settings/mcp.json` (workspace) or `~/.kiro/settings/mcp.json`
    (user):

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"] }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Kiro reloads MCP servers automatically. On first connect, `mcp-remote` opens
    your browser to sign in to Keupera and **Allow** access.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp", "--header", "Authorization: Bearer sk_live_your_key"]
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Confirm `keupera` is connected in Kiro's MCP view, then ask, for example:
*"Show my top keyword opportunities and outline an article for the best one."*

[Kiro MCP docs →](https://kiro.dev/docs/mcp)

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server won't start">
    Confirm Node.js is installed (`node --version`) and the JSON is valid. Kiro
    reloads automatically, but you can restart it to force a reload.
  </Accordion>

  <Accordion title="Browser sign-in doesn't open">
    Clear the cached auth and retry: delete the `mcp-remote` cache in
    `~/.mcp-auth` (or the path printed on startup), then reload the server.
  </Accordion>
</AccordionGroup>


# OpenCode
Source: https://docs.keupera.com/mcp/opencode

Connect Keupera to OpenCode as a remote MCP server.

[OpenCode](https://opencode.ai) connects to the Keupera MCP server as a
**remote** server. Authorize with OAuth (browser sign-in) or an API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Add Keupera to `opencode.json` (in your project) or
    `~/.config/opencode/opencode.json` (global):

    ```json theme={null}
    {
      "$schema": "https://opencode.ai/config.json",
      "mcp": {
        "keupera": { "type": "remote", "url": "https://mcp.keupera.com/mcp", "enabled": true }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Start OpenCode and sign in to Keupera in the browser when prompted.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "keupera": {
      "type": "remote",
      "url": "https://mcp.keupera.com/mcp",
      "enabled": true,
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Confirm the `keupera` tools are available, then ask, for example:
*"Show my top keyword opportunities and outline an article for the best one."*

[OpenCode MCP docs →](https://opencode.ai/docs/mcp-servers)

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server not loaded">
    Ensure `opencode.json` is valid, `"type"` is `"remote"`, and
    `"enabled": true`. Restart OpenCode to reload the config.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, restart and sign in again. For an API key, confirm the
    `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Available tools
Source: https://docs.keupera.com/mcp/tools

Every tool the Keupera MCP server exposes, grouped by module.

Once connected, the assistant has access to the tools below. Each maps to a
[Public API](/api-reference/introduction) endpoint and runs as your account.

<Tip>
  Start a session with **`keupera_me`** to confirm the connection and see the
  active account.
</Tip>

## Utilities

| Tool                        | What it does                                                                 |
| --------------------------- | ---------------------------------------------------------------------------- |
| `keupera_me`                | Return the authenticated user's profile. Use first to verify the connection. |
| `keupera_connect_framer`    | Register the connection with a Framer plugin install.                        |
| `keupera_connect_wordpress` | Connect a WordPress site so Keupera can publish to it.                       |

## Keywords

| Tool                               | What it does                                                             |
| ---------------------------------- | ------------------------------------------------------------------------ |
| `keupera_list_keywords`            | List tracked keywords with volume, difficulty, CPC, intent, opportunity. |
| `keupera_add_keywords`             | Add keywords to tracking (auto-enriches when volume is omitted).         |
| `keupera_delete_keywords`          | Remove keywords by id.                                                   |
| `keupera_star_keyword`             | Star or unstar a keyword.                                                |
| `keupera_update_keywords_status`   | Bulk update keyword status (e.g. archive).                               |
| `keupera_research_keywords`        | Run an AI + DataForSEO research job (async; returns a `job_id`).         |
| `keupera_get_keyword_research_job` | Poll a keyword research job.                                             |
| `keupera_list_keyword_groups`      | List keyword groups.                                                     |

## Backlinks

| Tool                                   | What it does                                           |
| -------------------------------------- | ------------------------------------------------------ |
| `keupera_list_backlink_campaigns`      | List backlink research campaigns.                      |
| `keupera_create_backlink_campaign`     | Create a campaign (queues research in the background). |
| `keupera_get_backlink_campaign`        | Fetch a campaign by id.                                |
| `keupera_list_backlink_opportunities`  | List discovered opportunities for a campaign.          |
| `keupera_get_backlink_recommendations` | AI strategy recommendations for a campaign.            |
| `keupera_get_backlink_opportunity`     | Fetch a single opportunity.                            |
| `keupera_update_backlink_opportunity`  | Update status, notes, contact, or outreach state.      |
| `keupera_generate_outreach_email`      | AI-draft a personalized outreach email.                |
| `keupera_send_outreach_email`          | Send the outreach email via the org's SMTP.            |

## Content

| Tool                               | What it does                                      |
| ---------------------------------- | ------------------------------------------------- |
| `keupera_list_articles`            | List articles in the content library.             |
| `keupera_create_article`           | Create an article manually or with AI generation. |
| `keupera_get_article`              | Fetch an article by id.                           |
| `keupera_update_article`           | Update article metadata or body.                  |
| `keupera_delete_article`           | Delete an article.                                |
| `keupera_generate_article_content` | Re-generate a draft article's body.               |
| `keupera_get_editorial_calendar`   | Scheduled articles grouped by date.               |
| `keupera_list_automation_jobs`     | List automation jobs (auto-publish, RSS, etc.).   |
| `keupera_update_automation`        | Update automation settings.                       |

## AI visibility

| Tool                                      | What it does                                   |
| ----------------------------------------- | ---------------------------------------------- |
| `keupera_get_ai_visibility_score`         | Latest AI-visibility score.                    |
| `keupera_list_brand_radar_campaigns`      | List Brand Radar campaigns.                    |
| `keupera_create_brand_radar_campaign`     | Monitor brand mentions across LLM providers.   |
| `keupera_delete_brand_radar_campaign`     | Delete a Brand Radar campaign.                 |
| `keupera_get_brand_radar_results`         | Mention / visibility results across providers. |
| `keupera_list_prompt_research_campaigns`  | List prompt research campaigns.                |
| `keupera_create_prompt_research_campaign` | Create a prompt research campaign.             |
| `keupera_get_prompt_research_campaign`    | Get a campaign and its results.                |

## Analytics

| Tool                                  | What it does                                           |
| ------------------------------------- | ------------------------------------------------------ |
| `keupera_get_website_summary`         | Visitors, page views, sessions, bounce rate.           |
| `keupera_get_website_daily`           | Daily time-series of summary metrics.                  |
| `keupera_get_website_top_pages`       | Most-visited pages.                                    |
| `keupera_get_website_referrers`       | Top referrers.                                         |
| `keupera_get_website_devices`         | Device-type breakdown.                                 |
| `keupera_get_website_browsers`        | Browser breakdown.                                     |
| `keupera_get_website_geo`             | Visitors by country.                                   |
| `keupera_get_search_console_daily`    | Daily clicks, impressions, CTR, position.              |
| `keupera_get_search_console_keywords` | Top organic search queries.                            |
| `keupera_get_search_console_pages`    | Top organic landing pages.                             |
| `keupera_get_bot_traffic_summary`     | Visits per AI bot (GPTBot, ClaudeBot, PerplexityBot…). |
| `keupera_get_bot_traffic_daily`       | Daily AI-bot visits per bot.                           |
| `keupera_get_bot_traffic_top_pages`   | Pages most visited by AI bots.                         |

<Note>
  Some tools consume credits (keyword research, backlink campaigns, AI content
  generation, outreach drafting). Your assistant should confirm before spending
  credits or performing destructive actions.
</Note>


# VS Code (GitHub Copilot)
Source: https://docs.keupera.com/mcp/vscode

Connect Keupera to VS Code's Copilot Chat as an HTTP MCP server.

[VS Code](https://code.visualstudio.com) connects to the Keupera MCP server via
**GitHub Copilot Chat** over HTTP. Authorize with OAuth (browser sign-in) or an
API key.

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Create `.vscode/mcp.json` in your workspace:

    ```json theme={null}
    {
      "servers": {
        "keupera": { "type": "http", "url": "https://mcp.keupera.com/mcp" }
      }
    }
    ```

    Or add it from the CLI:

    ```bash theme={null}
    code --add-mcp '{"name":"keupera","type":"http","url":"https://mcp.keupera.com/mcp"}'
    ```
  </Step>

  <Step title="Authorize">
    Start **keupera** in the Copilot Chat MCP view and sign in to Keupera in the
    browser when prompted.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "servers": {
    "keupera": {
      "type": "http",
      "url": "https://mcp.keupera.com/mcp",
      "headers": { "Authorization": "Bearer sk_live_your_key" }
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Open the Copilot Chat MCP view and confirm `keupera` is running, then ask, for
example: *"Show my top keyword opportunities and outline an article for the best
one."*

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server doesn't start">
    Confirm `.vscode/mcp.json` uses the `servers` key with `"type": "http"`, and
    that MCP support is enabled in Copilot Chat. Reload the window.
  </Accordion>

  <Accordion title="401 or 'unauthorized' errors">
    For OAuth, restart the server in the MCP view and sign in again. For an API
    key, confirm the `sk_live_…` value and that your plan includes API access.
  </Accordion>
</AccordionGroup>


# Windsurf
Source: https://docs.keupera.com/mcp/windsurf

Connect Keupera to Windsurf via the mcp-remote bridge.

[Windsurf](https://windsurf.com) proxies HTTP MCP servers through the
`mcp-remote` bridge, so it connects to the hosted Keupera server. Authorize with
OAuth (browser sign-in) or an API key.

<Note>
  `mcp-remote` runs via `npx`, so you need Node.js installed. No global install
  is required.
</Note>

## Option A — OAuth (sign in)

<Steps>
  <Step title="Add the server">
    Edit `~/.codeium/windsurf/mcp_config.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "keupera": { "command": "npx", "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp"] }
      }
    }
    ```
  </Step>

  <Step title="Authorize">
    Click **Refresh** in the MCP panel. On first connect, `mcp-remote` opens your
    browser to sign in to Keupera and **Allow** access.
  </Step>
</Steps>

## Option B — API key

```json theme={null}
{
  "mcpServers": {
    "keupera": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.keupera.com/mcp", "--header", "Authorization: Bearer sk_live_your_key"]
    }
  }
}
```

Get your key from **Settings → API Keys** in the
[dashboard](https://app.keupera.com).

## Verify and use

Click **Refresh** in the MCP panel and confirm `keupera` is connected, then ask,
for example: *"List my tracked keywords by opportunity and draft an article for
the top one."*

[Windsurf MCP docs →](https://docs.windsurf.com/windsurf/cascade/mcp)

## Troubleshooting

<AccordionGroup>
  <Accordion title="Server won't start">
    Confirm Node.js is installed (`node --version`) and the JSON is valid, then
    click **Refresh** in the MCP panel.
  </Accordion>

  <Accordion title="Browser sign-in doesn't open">
    Clear the cached auth and retry: delete the `mcp-remote` cache in
    `~/.mcp-auth` (or the path printed on startup), then click **Refresh**.
  </Accordion>
</AccordionGroup>


# Workflows
Source: https://docs.keupera.com/mcp/workflows

Practical SEO and GEO (AI visibility) workflows you can run through an AI assistant connected to Keupera.

Once connected, you drive Keupera in plain language. Below are proven recipes for
classic SEO and for **GEO** (Generative Engine Optimization — being cited by AI
answer engines like ChatGPT, Claude, Perplexity, and Google AI Overviews).

<Tip>
  Start a session with *"Check my Keupera connection"* — the assistant calls
  `keupera_me` to confirm it's authorized and which workspace is active.
</Tip>

## SEO: research → content

<Steps>
  <Step title="Find opportunities">
    *"Research keywords around 'cold brew coffee' for the US market and show the
    best by opportunity vs difficulty."*
  </Step>

  <Step title="Track the winners">
    *"Add the top 10 to tracking and group them under 'Cold Brew'."*
  </Step>

  <Step title="Draft and schedule">
    *"Draft an article targeting my highest-opportunity keyword, write SEO meta,
    and schedule it for next Monday."*
  </Step>
</Steps>

## Backlinks & outreach

* *"Create a backlink campaign for 'project management software' in the SaaS niche."*
* *"Show the best opportunities from that campaign and draft an outreach email for the top one."*
* *"Mark that opportunity as contacted and add a note."*

<Note>
  Outreach email is **sent** only when you explicitly ask, and may be disabled
  for OAuth-connected apps depending on your workspace settings.
</Note>

## Measure performance

* *"Summarize traffic for the last 30 days and the top 10 landing pages."*
* *"From Search Console, what queries am I ranking for on page 2 that I should target?"*
* *"Which pages lost the most clicks month over month?"*

## GEO / AI visibility

<Steps>
  <Step title="Baseline">
    *"What's my current AI visibility score?"*
  </Step>

  <Step title="Monitor brand mentions">
    *"Create a Brand Radar campaign with the questions my customers ask AI about
    \[topic], running weekly, and show where competitors are mentioned but I'm not."*
  </Step>

  <Step title="See what AI engines read">
    *"Which pages are AI bots like GPTBot and ClaudeBot crawling most?"*
  </Step>

  <Step title="Close the loop">
    *"Turn the prompts where my brand is missing into content briefs."*
  </Step>
</Steps>

## Tips for good results

* **Be specific** about market, language, and the website if you manage several.
* **Confirm credit spend** — research, AI generation, and campaigns consume
  credits; the assistant should ask before large or bulk runs.
* **Review before publishing or sending** — treat AI drafts and outreach as a
  first pass you approve.

See the [full tool reference](/mcp/tools) for everything the assistant can call.


# Quickstart
Source: https://docs.keupera.com/quickstart

Authenticate with the Keupera API and make your first request in minutes.

## Make your first Keupera API request

Follow these three steps to authenticate, call an endpoint, and inspect a response from the Keupera Public API.

### Step 1: Generate an API key

<AccordionGroup>
  <Accordion icon="key" title="Create a key from the dashboard">
    1. Log in to your [Keupera dashboard](https://app.keupera.com).
    2. Go to **Account → API Keys**.
    3. Click **Create API key** and copy it somewhere safe — you won't see it again.

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

  <Accordion icon="shield-check" title="Verify your plan includes API access">
    Public API access is tied to your subscription tier. If requests return `403 Forbidden`, upgrade your plan from **Settings → Billing** or contact [ask@support.keupera.com](mailto:ask@support.keupera.com).
  </Accordion>
</AccordionGroup>

### Step 2: Call your first endpoint

All endpoints live under:

```
https://app.keupera.com/api/v1
```

Authenticate using a `Bearer` token in the `Authorization` header. Here's a minimal request that lists keywords for the website attached to your API key:

<CodeGroup>
  ```bash cURL theme={null}
  curl https://app.keupera.com/api/v1/keywords \
    -H "Authorization: Bearer $KEUPERA_API_KEY"
  ```

  ```js Node.js theme={null}
  const res = await fetch(
    "https://app.keupera.com/api/v1/keywords",
    {
      headers: {
        Authorization: `Bearer ${process.env.KEUPERA_API_KEY}`,
      },
    }
  );
  const json = await res.json();
  console.log(json.data);
  ```

  ```python Python theme={null}
  import os, requests

  res = requests.get(
      "https://app.keupera.com/api/v1/keywords",
      headers={"Authorization": f"Bearer {os.environ['KEUPERA_API_KEY']}"},
  )
  print(res.json()["data"])
  ```
</CodeGroup>

### Step 3: Inspect the response

Successful responses return JSON with a consistent shape:

```json theme={null}
{
  "data": [
    {
      "id": "uuid",
      "term": "best seo tools",
      "volume": 12000,
      "difficulty": 45,
      "status": "active"
    }
  ],
  "meta": { "total": 150, "page": 1, "limit": 100 }
}
```

Errors return an `error` string with an HTTP status code between `400` and `500`:

```json theme={null}
{ "error": "Invalid or missing API key" }
```

## Next steps

Explore the API modules to build deeper integrations:

<CardGroup>
  <Card title="Keywords" icon="magnifying-glass" href="/api-reference/keywords">
    Research, enrich, and manage keywords programmatically.
  </Card>

  <Card title="Backlinks" icon="link" href="/api-reference/backlinks">
    Run outreach campaigns and track backlink opportunities.
  </Card>

  <Card title="Content" icon="pen-to-square" href="/api-reference/content">
    Plan, generate, and schedule AI-written articles.
  </Card>

  <Card title="AI Visibility" icon="robot" href="/api-reference/ai-visibility">
    Monitor your brand across LLM answers.
  </Card>

  <Card title="Analytics" icon="chart-line" href="/api-reference/analytics">
    Traffic, Search Console, and AI bot crawl data.
  </Card>

  <Card title="Full API overview" icon="book-open" href="/api-reference/introduction">
    Authentication, pagination, and error reference.
  </Card>
</CardGroup>

<Note>
  Need help? Email [ask@support.keupera.com](mailto:ask@support.keupera.com) or open the in-app chat from your dashboard.
</Note>