Integration guide

Connect your code to the Rank Prompt REST API

Pull AI visibility into your own dashboards and pipelines, or run reports from your backend, with a scoped key and a versioned /v1 API documented in OpenAPI 3.1.

Start free Explore the feature
REST API

Rank Prompt reads

  • Your requests
  • The key and its scopes

Rank Prompt sends

  • JSON for brands, reports and citations
  • Quota headers
  • Structured errors
Rank Prompt

What it does

  • Manages brands, prompts, reports, schedules, citations, content and SEO data from your backend.
  • Scopes each key to the resources it needs, and optionally to a single brand.
  • Makes writes safe to retry with an Idempotency-Key, and lets any call run as a free ?dry_run=true preview.
  • Publishes a machine-readable OpenAPI 3.1 spec, with a reference page for every endpoint.

Before you start

Plan Every plan, free included

  • A backend or script that can keep a secret. Browser calls are blocked: the API is server to server.
  • An API key from Developers, API Keys, shown once when you create it.
  • Every plan works, free included, with 1,000 requests a month on Free.
Setup

REST API setup in 4 steps

  1. Step 1

    Create a key

    In Rank Prompt, open Developers, API Keys and click Create key.

    The Create API key dialog: account, name, scopes, optional brand restriction and optional expiry.

  2. Step 2

    Choose its scopes, brand and expiry

    Give it a name you will recognize, the smallest set of scopes the integration needs, a brand if it should only reach one, and an expiry date for keys you hand to contractors.

  3. Step 3

    Store the key safely

    The full key, starting with rp_live_, is shown once. Put it in your secret manager, never in client-side code.

  4. Step 4

    Make the first call

    Call GET https://api.rankprompt.com/v1/me with Authorization: Bearer and your key. It confirms the key works and which account it acts in.

Troubleshooting

REST API: errors and fixes

These are the messages the app shows, word for word, and what fixes each one.

  • invalid_api_key: API key is invalid or revoked

    Check that the whole key was copied, starting with rp_live_, and that it was not revoked in Developers.

  • insufficient_scope: API key does not have the required scope

    The error’s details.required_scope names the scope to add. Create a key that includes it.

  • brand_not_authorized: API key is not authorized for this brand

    The key is restricted to another brand. Use a key for this brand, or one without a brand restriction.

  • request_quota_exceeded: Monthly request quota exceeded

    The plan’s monthly request allowance ran out. It resets with the billing period; the quota headers on every response show how much is left.

  • browser_calls_forbidden: The Public Developer API is server-to-server only. Browser CORS calls are blocked; call /v1 from your backend with a bearer API key.

    Move the call to your backend and keep the key there.

All integrations

FAQ

REST API integration FAQs

Still have questions? Contact our team

Is the API included in my plan?

Yes, on every plan, free included. The plan sets the monthly request allowance, from 1,000 requests on Free, and calls that do AI work use your plan credits.

Where is the API reference?

At rankprompt.com/docs/v1, generated from the same OpenAPI 3.1 spec the API serves, with every endpoint, scope, error code and credit cost.

Can a key reach only one client’s brand?

Yes. Restrict it to a brand when you create it, and any request for another brand answers brand_not_authorized, whatever scopes the key carries.

What about keys made in a team account?

A key acts in the account that was active when it was created. GET /v1/me shows account_id, account_role and account_plan, and the key stops working if you leave that account.

Up and running in a few minutes

Create a free account, follow the steps above and see what the connection adds to your AI visibility.

Start free View pricing