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/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}
  • +7 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}

White label

Logo, brand colors, footer copy and per-section toggles applied to PDF/HTML exports. Requires EDITOR access on the brand.

  • GET /v1/brands/{brand_id}/white-label
  • PATCH /v1/brands/{brand_id}/white-label

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 and brand summaries. 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}/shares
  • POST /v1/brands/{brand_id}/shares
  • DELETE /v1/brands/{brand_id}/shares
  • PATCH /v1/brands/{brand_id}/shares/{share_id}
  • +8 more

Alias suggestions

  • 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