Citera home
Browse documentation

Quickstart

Quickstart

Make your first API request and discover Citera from an MCP client.

Summarize with AIChatGPTClaudePerplexity

Before you begin

The Citera API and hosted MCP server are open to all Citera accounts. For an AI assistant, use browser sign-in to grant read-only access to selected brands. Create a scoped key when building with the REST API or when your MCP client needs the manual-key option.

The hosted MCP server URL is https://mcp.citeralabs.ai/mcp. Find it in Settings → API & MCP → MCP → Connect another assistant. The app’s settings page is where you manage access; paste the server URL, not the settings-page URL, into your AI client. REST requests use the separate API base URL configured for your workspace.

Create a scoped key

For REST requests, open Settings → API & MCP → API and create a key for the brands you own and the scopes you need. For this first read, use brands:read. Copy the token when it appears; it is shown once. For manual MCP access, use the MCP tab’s Connect another assistant dialog and choose Use an API key instead.

Store it in your backend’s secret manager. Do not place it in a public website, repository, browser bundle, query string, or cookie.

Configure your environment

Set CITERA_API_BASE_URL to your workspace API HTTPS origin, without /v1. The MCP example variable CITERA_MCP_URL is https://mcp.citeralabs.ai/mcp. CITERA_API_KEY is needed for the REST examples below, but browser-based MCP sign-in does not require you to create or paste a key.

export CITERA_API_BASE_URL="https://YOUR_ASSIGNED_API_HOST"
export CITERA_MCP_URL="https://mcp.citeralabs.ai/mcp"
export CITERA_API_KEY="YOUR_API_KEY"
export CITERA_API_BASE_URL="https://YOUR_ASSIGNED_API_HOST"
export CITERA_MCP_URL="https://mcp.citeralabs.ai/mcp"
export CITERA_API_KEY="YOUR_API_KEY"
export CITERA_API_BASE_URL="https://YOUR_ASSIGNED_API_HOST"
export CITERA_MCP_URL="https://mcp.citeralabs.ai/mcp"
export CITERA_API_KEY="YOUR_API_KEY"
export CITERA_API_BASE_URL="https://YOUR_ASSIGNED_API_HOST"
export CITERA_MCP_URL="https://mcp.citeralabs.ai/mcp"
export CITERA_API_KEY="YOUR_API_KEY"

Read your brands

curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands?limit=10" \
  -H "Authorization: Bearer $CITERA_API_KEY" \
  -H "Accept: application/json"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands?limit=10" \
  -H "Authorization: Bearer $CITERA_API_KEY" \
  -H "Accept: application/json"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands?limit=10" \
  -H "Authorization: Bearer $CITERA_API_KEY" \
  -H "Accept: application/json"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands?limit=10" \
  -H "Authorization: Bearer $CITERA_API_KEY" \
  -H "Accept: application/json"

A successful response contains data, has_more, next_cursor, and request_id. Select a brand ID returned by this call; an unbound brand ID returns 404 resource_not_found.

Check what the brand can do

export BRAND="UUID_RETURNED_BY_LIST_BRANDS"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands/$BRAND/capabilities" \
  -H "Authorization: Bearer $CITERA_API_KEY"
export BRAND="UUID_RETURNED_BY_LIST_BRANDS"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands/$BRAND/capabilities" \
  -H "Authorization: Bearer $CITERA_API_KEY"
export BRAND="UUID_RETURNED_BY_LIST_BRANDS"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands/$BRAND/capabilities" \
  -H "Authorization: Bearer $CITERA_API_KEY"
export BRAND="UUID_RETURNED_BY_LIST_BRANDS"
curl --fail-with-body "${CITERA_API_BASE_URL%/}/v1/brands/$BRAND/capabilities" \
  -H "Authorization: Bearer $CITERA_API_KEY"

Capabilities reflect the key, account, brand, and enabled features. Check them before offering generation or publishing actions in your integration.

Connect an assistant

For Claude Code, add the remote server with this command. Then open /mcp, select Citera and complete browser sign-in. Choose which brands the read-only connection may access. If Citera is already available through your Claude account, use that existing connection.

claude mcp add --transport http --scope user citera 'https://mcp.citeralabs.ai/mcp'
claude mcp add --transport http --scope user citera 'https://mcp.citeralabs.ai/mcp'
claude mcp add --transport http --scope user citera 'https://mcp.citeralabs.ai/mcp'
claude mcp add --transport http --scope user citera 'https://mcp.citeralabs.ai/mcp'

Ask the assistant to list your brands. The actual wire tool is rankad_list_brands. Existing rankad_* tool names, the server name rankad, and the rk_live_ key prefix are intentional compatibility identifiers.

Where to go next

  • Authentication and access — key lifecycle and authentication.

  • Scopes and permissions — minimum permissions and dependencies.

  • REST endpoint index — every customer API route.

  • MCP client setup — Claude Code, Cursor and raw requests.

  • Generate and publish — production-minded workflows.

  • Limits and credits — shared API/MCP allowances.

Choose your MCP client

Use the connection guide to choose Claude, ChatGPT, Gemini CLI, Cursor, Lovable, Replit or VS Code. Client plans and workspace policies can affect whether custom MCP connections are available.

Open the MCP client setup guides

Request examples

Choose a language for each endpoint. Set your assigned HTTPS API origin and environment variables, then replace the <placeholders>. These examples do not run requests in your browser.

GET/v1/brands

Required scope: brands:read · Response: 200

: "${CITERA_API_BASE_URL:?Set CITERA_API_BASE_URL}"
: "${CITERA_API_KEY:?Set CITERA_API_KEY}"
curl --fail-with-body --connect-timeout 10 --max-time 30 -X GET "${CITERA_API_BASE_URL%/}/v1/brands" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${CITERA_API_KEY}"