API Overview - Keupera Docs

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.

Keywords

Research, enrich, star, and group keywords.

Backlinks

Run campaigns and generate outreach.

Content

Plan, generate, and publish articles.

AI Visibility

Track your brand across LLM answers.

Analytics

Traffic, Search Console, and bot data.

Account

Verify keys and connect a CMS.

Base URL

All resources are served under a single versioned prefix:

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

Authentication

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

Authorization: Bearer YOUR_KEUPERA_API_KEY

Generate keys from Account → API Keys in your Keupera dashboard. 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).

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.

Make your first request

Grab your API key

Open Account → API Keys in the dashboard and copy a key.

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.

curl https://app.keupera.com/api/v1/me \
  -H "Authorization: Bearer YOUR_KEUPERA_API_KEY"

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);

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"])

Fetch some data

List your keywords. Use the API Explorer on any endpoint page to try it live and copy the generated code.

curl "https://app.keupera.com/api/v1/keywords?limit=10" \
  -H "Authorization: Bearer YOUR_KEUPERA_API_KEY"

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:

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.

uuid

Override the target website. Defaults to the API key’s website.

integer

Number of results to return. Default varies per endpoint.

integer

default:"1"

Page number for paginated endpoints.

string

default:"30d"

Analytics only. Preset date range — one of 7d, 30d, 90d.

string

Analytics only. Start date (YYYY-MM-DD).

string

Analytics only. End date (YYYY-MM-DD).

When both from and to are provided, range is ignored.

Response format

All responses are JSON and follow a consistent envelope.

{
  "data": [ /* ... */ ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20
  }
}

{ "error": "Descriptive error message" }

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

401 — Invalid or missing API key

Confirm the Authorization: Bearer <key> header is present and the key is active. Test with GET /me, which bypasses the paid-tier check.

402 — Usage limit reached

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.

403 — Forbidden

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.

Long-running jobs (202)

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.

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 to run these same operations from Claude, Cursor, or any MCP-compatible client without writing HTTP calls yourself.

Keywords

Backlinks

Content

AI Visibility

Analytics

Account

​Base URL

​Authentication

​Make your first request

​Scoping to a specific website

​Common parameters

​Response format

​HTTP status codes

​Rate limits & usage

​Handling errors

​CORS

​Prefer natural language?

Base URL

Authentication

Make your first request

Scoping to a specific website

Common parameters

Response format

HTTP status codes

Rate limits & usage

Handling errors

CORS

Prefer natural language?