RankBits API
AI visibility scans from your own workflow
Create scans asynchronously, check plan and credit usage, and retrieve detailed AI visibility results over HTTP.
Quick start
Samples update when you change the token or language.
API access
API tokens are available to every registered RankBits user, including free accounts after email verification.
Authentication
Send your token in the `Authorization` header. Keep tokens server-side and revoke them from this page if they are exposed.
Authorization: Bearer rb_your_token_hereEndpoints
| Method | Endpoint | Use |
|---|---|---|
| GET | /v1/me | Returns user, plan, monthly response budget, and purchased credits. |
| POST | /v1/scans | Creates a scan and starts it in the background. Returns immediately with IDs and links. |
| GET | /v1/scans/{id} | Retrieves status, progress, prompts, aggregate metrics, and result rows for your scan. |
Create Scan
The scan endpoint accepts the same limits as the app. It checks email verification, plan engines, brand limits, cooldowns, and available response credits before starting.
Scan Results
While a scan is running, results include metadata, prompts, aggregate data available so far, and progress counts. Completed scans include answer text, citations, competitor stats, prompt breakdown, share of voice, and visibility scores.
{
"scan": {"public_id": "abc123", "status": "done"},
"progress": {"completed_results": 70, "expected_results": 70, "complete": true},
"aggregate": {"overall": {}, "providers": {}, "comparison": []},
"prompts": [],
"results": [],
"prompt_breakdown": []
}Provider keys
Use these values in the optional providers array. Omit the field to use every engine allowed by your plan.
ChatGPT answers with fast, general-purpose web-aware reasoning.
GPT-5.5 responses for deeper reasoning and higher-quality synthesis.
Google AI Mode-style search response.
Google AI Overview-style summary.
Gemini answers with strong Google-native reasoning and broad web context.
Traditional Google organic results for baseline search visibility.
Traditional Bing organic results for baseline search visibility.
Bing Copilot AI-generated search answers with source references.
Perplexity search answers with citations from current web sources.
Claude answers with careful summarization and citation-aware reasoning.
Claude Pro responses for premium long-form analysis and strategy.
Tavily web search for AI-friendly source discovery and citations.
Exa neural search for finding semantically relevant web sources.
Gemini Pro responses for richer analysis on complex prompts.