API docs v1

API reference

Every Rank Prompt /v1 endpoint, organized by resource. Browse operations, schemas, and copy-paste-ready code samples for cURL, Node.js, and Python.

Spec version v1

Resources

Account

Inspect the principal behind the current API key and the request quota for the active billing period.

  • GET /v1/me
  • GET /v1/me/credits
  • GET /v1/me/quota
  • GET /v1/me/usage

Brands

Create, read, update and delete brands. Brand-restricted API keys are scoped to a single brand and cannot mint new ones.

  • GET /v1/brands
  • POST /v1/brands
  • GET /v1/brands/{brand_id}
  • PATCH /v1/brands/{brand_id}
  • +1 more

Brand facts

LLM-researched brand profile (description, industry, value proposition, and more). Generated synchronously via POST /v1/brands/{id}/facts; the call may block up to 180s.

  • GET /v1/brands/{brand_id}/facts
  • POST /v1/brands/{brand_id}/facts
  • PATCH /v1/brands/{brand_id}/facts

Reports

Create, list, retrieve and re-run AI visibility reports. Report creation is asynchronous and returns a job_id you can poll on GET /v1/jobs/{id}.

  • GET /v1/reports
  • POST /v1/reports
  • GET /v1/reports/{report_id}
  • PATCH /v1/reports/{report_id}
  • +10 more

Region configs

Read region configurations attached to a brand. Region configs drive scheduled report fan-out across markets.

  • GET /v1/region-configs
  • POST /v1/region-configs
  • GET /v1/region-configs/{region_config_id}
  • PATCH /v1/region-configs/{region_config_id}
  • +6 more

Scheduled reports

CRUD for scheduled report definitions. Each schedule fires a new report at the configured frequency (daily/weekly/monthly).

  • GET /v1/scheduled-reports
  • POST /v1/scheduled-reports
  • GET /v1/scheduled-reports/{scheduled_report_id}
  • PATCH /v1/scheduled-reports/{scheduled_report_id}
  • +6 more

Jobs

Poll the status of asynchronous jobs (e.g. report generation). Each job is principal-isolated: keys can only see jobs they started; brand-restricted keys can only see jobs for their brand.

  • GET /v1/jobs
  • GET /v1/jobs/{job_id}
  • DELETE /v1/jobs/{job_id}

Export sections

Per-section toggles controlling which blocks appear in a brand's PDF/HTML report exports. Reading is a viewer action; editing requires EDITOR access on the brand.

  • GET /v1/brands/{brand_id}/export-sections
  • PATCH /v1/brands/{brand_id}/export-sections

Page audit

Run a rule-based SEO/AEO best-practice audit on any public page and get an overall score plus concrete recommendations. Costs 1 credit per run; ideal for CI checks via the GitHub Action.

  • POST /v1/page-audit

Citations

Per-brand URL citations powering the outreach pipeline. List, filter and roll up the pages where the brand appeared (or could appear) across AI assistants, with the Rank Prompt Score (field name rankprompt_score), domain authority, mention sentiment and per-platform mention counts.

  • GET /v1/brands/{brand_id}/citations
  • GET /v1/brands/{brand_id}/citations/by-domain
  • GET /v1/citations/{citation_id}

Shares

Time-limited public share links for reports, scheduled reports, brand summaries and brand audits. Each share is a read-only snapshot resolved at /shared/{access_token}. POST is idempotent; pass rotate=true to invalidate a leaked URL.

  • GET /v1/brands/{brand_id}/audits/{audit_id}/shares
  • POST /v1/brands/{brand_id}/audits/{audit_id}/shares
  • DELETE /v1/brands/{brand_id}/audits/{audit_id}/shares
  • PATCH /v1/brands/{brand_id}/audits/{audit_id}/shares/{share_id}
  • +12 more

Alias suggestions

Detected name variants for a brand that are not yet counted as the brand. Accept the correct ones so future reports attribute those mentions, or dismiss the wrong ones.

  • GET /v1/brands/{brand_id}/alias-suggestions
  • DELETE /v1/brands/{brand_id}/alias-suggestions/{business_name}
  • POST /v1/brands/{brand_id}/alias-suggestions/{business_name}/acceptances

Competitors

The brand's cross-report competitor registry: entities that show up alongside it in AI answers, ranked by share of voice. Reclassify, merge duplicates, or remove entities to keep the registry accurate.

  • GET /v1/brands/{brand_id}/competitors
  • PATCH /v1/brands/{brand_id}/competitors/{competitor_id}
  • DELETE /v1/brands/{brand_id}/competitors/{competitor_id}
  • POST /v1/brands/{brand_id}/competitors/merges

Content

Report-driven content opportunities, ranked by impact: topics where competitors are cited and the brand is not. The highest-leverage list for AEO content work.

  • GET /v1/brands/{brand_id}/content-briefs
  • POST /v1/brands/{brand_id}/content-briefs
  • GET /v1/brands/{brand_id}/content-briefs/{brief_id}
  • DELETE /v1/brands/{brand_id}/content-briefs/{brief_id}
  • +2 more

Brand audits

Full AI-visibility audits for a single market (country + language), with generated recommendations and citation analysis. Audit runs cost credits.

  • GET /v1/brands/{brand_id}/audits
  • POST /v1/brands/{brand_id}/audits
  • GET /v1/brands/{brand_id}/audits/{audit_id}
  • POST /v1/brands/{brand_id}/audits/{audit_id}/citations
  • +1 more

SEO pages

Track pages and run Lighthouse/PageSpeed audits plus technical SEO crawls on them. Includes Core Web Vitals history and ready-to-paste structured-data templates. Audits cost credits.

  • GET /v1/brands/{brand_id}/schema-templates
  • GET /v1/brands/{brand_id}/seo-pages
  • POST /v1/brands/{brand_id}/seo-pages
  • GET /v1/brands/{brand_id}/seo-pages/{page_id}
  • +9 more

Tasks

The brand's action items (content, technical, outreach) created by report AI suggestions and the agent, with status and priority. Deleting a task requires OWNER access.

  • GET /v1/brands/{brand_id}/tasks
  • POST /v1/brands/{brand_id}/tasks
  • PATCH /v1/brands/{brand_id}/tasks/{task_id}
  • DELETE /v1/brands/{brand_id}/tasks/{task_id}
  • +1 more

Analytics

Read the brand's Google Analytics 4 / Search Console connection status. Connecting a Google account is done in the app, not the API.

  • GET /v1/brands/{brand_id}/analytics/connection

Search Console

Google Search Console data for a connected brand: submitted sitemaps and URL inspection (indexing status).

  • GET /v1/brands/{brand_id}/search-console/sitemaps
  • GET /v1/brands/{brand_id}/search-console/url-inspection

Webhooks

Register endpoints to receive event notifications (e.g. a report finishing), and inspect recent deliveries.

  • GET /v1/brands/{brand_id}/webhooks
  • POST /v1/brands/{brand_id}/webhooks
  • GET /v1/brands/{brand_id}/webhooks/{webhook_id}
  • PATCH /v1/brands/{brand_id}/webhooks/{webhook_id}
  • +4 more