Browse documentation
DEVELOPER DOCUMENTATION
Bring AI visibility, content, and publishing into your own workflows. Use the REST API for applications and pipelines, or connect an AI assistant through MCP.
Scale & Enterprise · Invite-only beta
Your account must be enrolled before creating keys. Write capabilities are enabled for approved cohorts. The Citera team supplies your deployed API and MCP URLs.
Make your first request
Create a scoped key and read your first bound brand.
Connect an AI assistant
Set up Claude Code, Cursor, or a direct MCP client.
Explore the REST API
47 routes, required scopes, and request contracts.
Find an MCP tool
39 tools for discovery, generation, and product workflows.
One key. Two ways to build.
Both surfaces share your brand permissions, scopes, and allowance. Set CITERA_API_BASE_URL to your assigned HTTPS origin, then make a read-only request.
Get started
Set up access and understand brand isolation.
Quickstart
Make your first API request and discover Citera from an MCP client.
Authentication and access
Enroll in the beta, create keys, and authenticate every request.
Scopes and permissions
All 22 scopes, dependencies, and beta write permissions.
Brand scoping and IDs
Understand brand isolation and identify every API resource.
API fundamentals
Build reliable clients before adding writes.
Requests and responses
JSON envelopes, response headers, strict input, and pagination.
Errors and retries
HTTP status codes, retryable failures, and request correlation.
Limits and credits
Scale and Enterprise quotas, operation costs, and monthly usage.
Idempotency
Retry chargeable operations without creating duplicate work.
Asynchronous jobs
Poll generation and publishing, understand status, and cancel queued work.
REST reference
Request contracts, resources, and endpoint details.
REST endpoint index
Every customer REST route, required scope, and response status.
API keys
Create, list, update, rotate, and revoke keys.
Brands and capabilities
Discover bound brands and enabled capabilities.
Prompt library
Find search opportunities, prompts, and prompt-level metrics.
Scan runs
Read scan history, status, and model coverage.
Visibility
Query AI search visibility by period and model.
Recommendations
List and inspect content recommendations.
Content and drafts
Read generated content, safely edit drafts, and select cover images.
Content generation
Start an idempotent content generation job.
Integrations
Discover sanitized integration health and destination capabilities.
Preview and publishing
Validate a destination, publish with confirmation, and verify results.
Usage
Read effective API/MCP consumption, credits, and limits.
OpenAPI contract
Retrieve the machine-readable REST contract from your assigned host.
Resource objects
Field reference for keys, brands, prompts, content, jobs, operations, and usage.
Product APIs
Work with the same Calendar, Results, Website, Local, and image data as the app.
Calendar
Read a calendar, edit topics, cancel schedules, and reschedule publications.
Results
Read performance and explicitly refresh social metrics.
Website
Inventory, changes, verification, publish, recheck, undo, and operating mode.
Local
Read locations, run Local, and manage recommendations and location data.
Image bank
Read images associated with your brand and generated content.
MCP
Connect assistants and understand every tool.
MCP overview
Transport, authentication, discovery, server instructions, and quotas.
Connect an MCP client
Configure Claude Code, Cursor, HTTP clients, or a stdio bridge.
MCP tool catalogue
All 39 wire tool names, arguments, scopes, and REST equivalents.
MCP results and safety
Structured results, truncation, tool errors, and untrusted text.
Guides
Practical workflows, client examples, and security.
Generate and publish
Discover opportunities, generate an article, preview, and publish safely.
Client examples
Minimal TypeScript and Python clients with explicit error and retry handling.
Security practices
Protect credentials, constrain assistant tools, and validate external actions.
Content types and channels
Content formats, lifecycle enums, destination compatibility, and surface limits.
Need a hand?
Include the server request_id and a safe key display prefix when asking for help. Keep API keys and bearer tokens private.