This website uses cookies
We use cookies to personalise content, provide social features and analyse traffic with our analytics and marketing partners. Choose which optional cookies to allow. Cookie policy.
This website uses cookies
We use cookies to personalise content and improve your experience, to provide social media features and to analyse our traffic. We also share information about your use of our site with our analytics and marketing partners, who may combine it with other information that you have provided to them or that they have collected from your use of their services.
Cookie details
About these controls
You can choose which optional cookie categories to allow. Necessary cookies remain enabled because they support essential website functions. Read more in our cookie policy.
Connect Citera to Claude
mcp-claude
Connect Claude and Claude Code to Citera with browser sign-in, then verify read-only brand access.
MCP
Connect Claude and Claude Code to Citera with browser sign-in, then verify read-only brand access.
Developers
30.01
Connect Citera to ChatGPT
mcp-chatgpt
Add Citera as a custom MCP connection in ChatGPT using OAuth and verify the selected brands.
MCP
Add Citera as a custom MCP connection in ChatGPT using OAuth and verify the selected brands.
Developers
30.02
Connect Citera to Gemini CLI
mcp-gemini-cli
Configure Gemini CLI’s remote HTTP MCP connection, authenticate in a browser and verify Citera tools.
MCP
Configure Gemini CLI’s remote HTTP MCP connection, authenticate in a browser and verify Citera tools.
Developers
30.03
Connect Citera to Cursor
mcp-cursor
Add Citera to Cursor’s personal MCP configuration using browser sign-in or a manual MCP key.
MCP
Add Citera to Cursor’s personal MCP configuration using browser sign-in or a manual MCP key.
Developers
30.04
Connect Citera to Lovable
mcp-lovable
Add Citera as a Lovable chat connector using the remote MCP server and browser sign-in.
MCP
Add Citera as a Lovable chat connector using the remote MCP server and browser sign-in.
Developers
30.05
Connect Citera to Replit
mcp-replit
Add Citera to Replit Agent as a custom MCP server, authorize read-only brands and test the connection.
MCP
Add Citera to Replit Agent as a custom MCP server, authorize read-only brands and test the connection.
Developers
30.06
Connect Citera to VS Code
mcp-vs-code
Configure Citera as a remote HTTP MCP server in VS Code and verify read-only access in Agent chat.
MCP
Configure Citera as a remote HTTP MCP server in VS Code and verify read-only access in Agent chat.
Developers
30.07
Weekly AI visibility brief
weekly-ai-visibility-brief
Full AI search week in review, delivered in one query.
MCP
Full AI search week in review, delivered in one query.
/mcp/weekly-ai-visibility-brief
Developers
33
White label client report
white-label-client-report
Create personalized reports to share wins with your clients using your own branding.
MCP
Create personalized reports to share wins with your clients using your own branding.
/mcp/white-label-client-report
Developers
34
Find pages losing visibility
find-pages-losing-visibility
Identify content that once earned AI citations and is now losing ground.
MCP
Identify content that once earned AI citations and is now losing ground.
/mcp/find-pages-losing-visibility
Developers
35
Product glossary
product-glossary
A quick reference for prompts, mentions, citations, visibility, and credits.
Reference
A quick reference for prompts, mentions, citations, visibility, and credits.
Reference
1
Getting started with Citera
getting-started-with-citera
Learn how Citera connects your brand, maps your AI search visibility, and gives you a clear first action.
Learn how Citera connects your brand, maps your AI search visibility, and gives you a clear first action.
Getting started
0
How AI models see your brand
how-ai-models-see-your-brand
Understand the differences between ChatGPT, Claude, Gemini, Perplexity, and Google AI Overviews.
Understand the differences between ChatGPT, Claude, Gemini, Perplexity, and Google AI Overviews.
AI visibility
0
Create your first tracked prompt set
create-your-first-tracked-prompt-set
Turn the questions your buyers ask into a focused tracking setup.
Turn the questions your buyers ask into a focused tracking setup.
Tracking
0
Turn visibility gaps into action
turn-visibility-gaps-into-action
Read your findings, understand opportunities, and prioritize the next best move.
Read your findings, understand opportunities, and prioritize the next best move.
Workflows
0
Share reports with your team
share-reports-with-your-team
Package progress and insights into an AI-search story people can act on.
Package progress and insights into an AI-search story people can act on.
Reporting
0
Quickstart
quickstart
Make your first API request and discover Citera from an MCP client.
Get started
Make your first API request and discover Citera from an MCP client.
Developers
1
Authentication and access
authentication
Create API keys and authenticate requests. API and MCP access is open to everyone.
Get started
Create API keys and authenticate requests. API and MCP access is open to everyone.
Developers
2
Scopes and permissions
scopes
All 22 scopes, their dependencies, and permissions for API and MCP operations.
Get started
All 22 scopes, their dependencies, and permissions for API and MCP operations.
Developers
3
Brand scoping and IDs
brand-scoping
Understand brand isolation and identify every API resource.
Get started
Understand brand isolation and identify every API resource.
Developers
4
Requests and responses
conventions
JSON envelopes, response headers, strict input, and pagination.
API fundamentals
JSON envelopes, response headers, strict input, and pagination.
Developers
5
Errors and retries
errors
HTTP status codes, retryable failures, and request correlation.
API fundamentals
HTTP status codes, retryable failures, and request correlation.
Developers
6
Limits and credits
limits-and-credits
Account quotas, operation costs, and monthly usage.
API fundamentals
Account quotas, operation costs, and monthly usage.
Developers
7
Idempotency
idempotency
Retry chargeable operations without creating duplicate work.
API fundamentals
Retry chargeable operations without creating duplicate work.
Developers
8
Asynchronous jobs
jobs
Poll generation and publishing, understand status, and cancel queued work.
API fundamentals
Poll generation and publishing, understand status, and cancel queued work.
Developers
9
REST endpoint index
rest-endpoints
Every customer REST route, required scope, and response status.
REST reference
Every customer REST route, required scope, and response status.
Developers
10
API keys
api-keys
Create, list, update, rotate, and revoke keys.
REST reference
Create, list, update, rotate, and revoke keys.
Developers
11
Brands and capabilities
brands
Discover bound brands and enabled capabilities.
REST reference
Discover bound brands and enabled capabilities.
Developers
12
Prompt library
prompt-library
Find search opportunities, prompts, and prompt-level metrics.
REST reference
Find search opportunities, prompts, and prompt-level metrics.
Developers
13
Scan runs
scan-runs
Read scan history, status, and model coverage.
REST reference
Read scan history, status, and model coverage.
Developers
14
Visibility
visibility
Query AI search visibility by period and model.
REST reference
Query AI search visibility by period and model.
Developers
15
Recommendations
recommendations
List and inspect content recommendations.
REST reference
List and inspect content recommendations.
Developers
16
Content and drafts
content
Read generated content, safely edit drafts, and select cover images.
REST reference
Read generated content, safely edit drafts, and select cover images.
Developers
17
Content generation
generation
Start an idempotent content generation job.
REST reference
Start an idempotent content generation job.
Developers
18
Integrations
integrations
Discover sanitized integration health and destination capabilities.
REST reference
Discover sanitized integration health and destination capabilities.
Developers
19
Preview and publishing
publishing
Validate a destination, publish with confirmation, and verify results.
REST reference
Validate a destination, publish with confirmation, and verify results.
Developers
20
Calendar
calendar
Read a calendar, edit topics, cancel schedules, and reschedule publications.
Product APIs
Read a calendar, edit topics, cancel schedules, and reschedule publications.
Developers
21
Results
results
Read performance and explicitly refresh social metrics.
Product APIs
Read performance and explicitly refresh social metrics.
Developers
22
Website
website
Inventory, changes, verification, publish, recheck, undo, and operating mode.
Product APIs
Inventory, changes, verification, publish, recheck, undo, and operating mode.
Developers
23
Local
local
Read locations, run Local, and manage recommendations and location data.
Product APIs
Read locations, run Local, and manage recommendations and location data.
Developers
24
Image bank
image-bank
Read images associated with your brand and generated content.
Product APIs
Read images associated with your brand and generated content.
Developers
25
Usage
usage
Read effective API/MCP consumption, credits, and limits.
REST reference
Read effective API/MCP consumption, credits, and limits.
Developers
26
OpenAPI contract
openapi
Retrieve the machine-readable REST contract from your assigned host.
REST reference
Retrieve the machine-readable REST contract from your assigned host.
Developers
27
Resource objects
resource-objects
Field reference for keys, brands, prompts, content, jobs, operations, and usage.
REST reference
Field reference for keys, brands, prompts, content, jobs, operations, and usage.
Developers
28
MCP overview
mcp-overview
Transport, authentication, discovery, server instructions, and quotas.
MCP
Transport, authentication, discovery, server instructions, and quotas.
Developers
29
Connect an MCP client
mcp-clients
Find your MCP server URL, choose browser sign-in or a manual key, and follow a client-specific setup guide.
MCP
Find your MCP server URL, choose browser sign-in or a manual key, and follow a client-specific setup guide.
Developers
30
MCP tool catalogue
mcp-tools
All 39 wire tool names, arguments, scopes, and REST equivalents.
MCP
All 39 wire tool names, arguments, scopes, and REST equivalents.
Developers
31
MCP results and safety
mcp-results
Structured results, truncation, tool errors, and untrusted text.
MCP
Structured results, truncation, tool errors, and untrusted text.
Developers
32
Generate and publish
workflows
Discover opportunities, generate an article, preview, and publish safely.
Guides
Discover opportunities, generate an article, preview, and publish safely.
Developers
33
Client examples
client-examples
Minimal TypeScript and Python clients with explicit error and retry handling.
Guides
Minimal TypeScript and Python clients with explicit error and retry handling.
Developers
34
Security practices
security
Protect credentials, constrain assistant tools, and validate external actions.
Guides
Protect credentials, constrain assistant tools, and validate external actions.
Developers
35
Content types and channels
content-types-and-channels
Content formats, lifecycle enums, destination compatibility, and surface limits.
Guides
Content formats, lifecycle enums, destination compatibility, and surface limits.
Developers
36
API & MCP release notes
api-mcp-release-notes
Reference baselines, compatibility notes, deprecations, and a migration checklist for API and MCP clients.
Release notes
Reference baselines, compatibility notes, deprecations, and a migration checklist for API and MCP clients.
Developers
100
Browse documentation
Requests and responses
Requests and responses
JSON envelopes, response headers, strict input, and pagination.
Envelopes
Single resource:
{ "data": { "...": "..." }, "request_id": "req_…" }
{ "data": { "...": "..." }, "request_id": "req_…" }
{ "data": { "...": "..." }, "request_id": "req_…" }
{ "data": { "...": "..." }, "request_id": "req_…" }
List:
{ "data": [{ "object": "brand", "id": "11111111-1111-4111-8111-111111111111" }], "has_more": true, "next_cursor": "eyJrIjoi…", "request_id": "req_…" }
{ "data": [{ "object": "brand", "id": "11111111-1111-4111-8111-111111111111" }], "has_more": true, "next_cursor": "eyJrIjoi…", "request_id": "req_…" }
{ "data": [{ "object": "brand", "id": "11111111-1111-4111-8111-111111111111" }], "has_more": true, "next_cursor": "eyJrIjoi…", "request_id": "req_…" }
{ "data": [{ "object": "brand", "id": "11111111-1111-4111-8111-111111111111" }], "has_more": true, "next_cursor": "eyJrIjoi…", "request_id": "req_…" }
Error: see errors and retries.
Headers
Response header | When |
|---|---|
| Always — quote it to support |
| Always |
| After quota admission: the tightest per-minute bucket; reset is a Unix timestamp (seconds) |
| On |
| When an idempotent request returns a stored response |
| On |
CORS: /v1/* allows any origin without credentials and exposes the headers above. /v1/api-keys* only allows approved application origins.
Data conventions
Timestamps are RFC 3339 UTC strings (
2026-10-26T12:00:00.000Z).All request schemas are strict: unknown fields give
400 unknown_fieldwithparamnaming the field.Free text is trimmed, control characters are stripped, and length is capped.
No serializer copies a database row wholesale; every field is named.
Credential-like columns (access_token,encrypted_app_pw,token_hash,config,embedding,raw_response, …) can never appear (enforced by tests).Request bodies are limited to 1 MB.
Pagination
There are three cursor styles. Always pass next_cursor back unchanged.
Style | Endpoints |
|
|
|---|---|---|---|
Keyset (opaque base64url) | All original list endpoints, API keys, | 1–100, default 25 | ≤ 512 chars; malformed → |
Offset (numeric string | Calendar, Results, Website changes/change detail, Local, image bank | 1–100, default 50 | e.g. |
Event ID (numeric string, ≤ 18 digits) |
| 1–100, default 50 | last event ID |
Keyset lists are sorted newest first (created_at desc, then id). Offset pagination does not exist on keyset endpoints. For current-product pages, has_more and next_cursor are inside data.data (see API reference).