Endpoint index - OpenRush

This page lists the public endpoints developers can call directly. Most non-technical users should start with Get started or Connect an AI agent. Use /v1/capabilities as the live source of truth before calling optional tools.

Discovery

Method	Path	Auth	Purpose
`GET`	`/v1/capabilities`	No	Discover enabled domains, tools, sources, defaults, fact types, and credit costs
`POST`	`/v1/capabilities`	No	Same as `GET /v1/capabilities`

Account

Method	Path	Auth	Purpose
`GET`	`/v1/me/credits`	Account	Read your current credit balance
`GET`	`/v1/me/api-credentials`	Account	List API keys for your account
`POST`	`/v1/me/api-credentials`	Account	Create an API key
`POST`	`/v1/me/api-credentials/{credential_id}/revoke`	Account	Revoke one of your API keys
`GET`	`/v1/me/usage`	Account	Read recent API and MCP activity

Tools

Method	Path	Credits	Purpose
`POST`	`/v1/tools/inspect_domain`	9	Starting map for one domain
`POST`	`/v1/tools/discover_competitors`	7	Find organic competitors
`POST`	`/v1/tools/research_keywords`	3	Expand a seed term into keyword ideas
`POST`	`/v1/tools/compare_keyword_coverage`	12	Find keyword gaps against competitors
`POST`	`/v1/tools/inspect_backlinks`	9	Inspect a domain’s link profile, sliced by view
`POST`	`/v1/tools/compare_backlink_gap`	40	Backlink gap: who links to rivals but not you, ranked and filtered
`POST`	`/v1/tools/inspect_serp`	2	Fetch a live SERP snapshot
`POST`	`/v1/tools/inspect_search_visibility`	10	Check ranking positions across keywords
`POST`	`/v1/tools/inspect_ai_visibility`	20	How often a domain is cited in AI Overviews, vs competitors
`POST`	`/v1/tools/discover_ai_citations`	22	Which domains AI cites across a category
`POST`	`/v1/tools/audit_site`	9	Audit sampled pages for technical and content issues
`POST`	`/v1/tools/inspect_keyword`	5	Drill into one keyword
`POST`	`/v1/tools/inspect_page`	3	Drill into one URL
`POST`	`/v1/tools/export_dataset`	1	Fetch full rows from an `openrush://` resource

Owned data (Search Console, Analytics & Google Ads)

These need a connected Google source — Search Console for search performance, Google Analytics for website traffic, Google Ads for ad performance — and appear only when owned data is enabled for your account. See Connections.

Method	Path	Credits	Purpose
`POST`	`/v1/tools/get_search_performance`	2	Your measured Search Console clicks, impressions, CTR, and position
`POST`	`/v1/tools/get_website_analytics`	2	Your measured Google Analytics sessions, users, and engagement
`POST`	`/v1/tools/get_ad_performance`	2	Your measured Google Ads spend, clicks, conversions, and ROAS
`GET`	`/v1/me/websites`	0	List your websites (with each one’s connection state) and activated ad accounts

Connecting a property or activating an ad account is Dashboard-only, since Google OAuth requires human consent. See Connections.

Monitors

Monitor tools appear only when monitors are enabled for your deployment. See Monitor tools.

Method	Path	Credits	Purpose
`POST`	`/v1/tools/create_monitor`	First check	Create a monitor from a template; runs the first check now
`POST`	`/v1/tools/list_monitors`	0	List monitors with cost, state, and credit runway
`POST`	`/v1/tools/get_monitor_history`	0	Metric series, changes, one row over time, and logged changes
`POST`	`/v1/tools/update_monitor`	0 (`run_now`: one check)	Rename, change how often, pause, resume, run now, or delete
`POST`	`/v1/tools/log_change`	0	Record what was changed
`GET`	`/v1/me/monitoring/templates`	0	Monitor templates and their cadences
`POST`	`/v1/me/monitoring/estimate`	0	Steps and cost of a monitor, without creating it
`GET`	`/v1/me/monitoring/consent`	0	Whether the account accepted the Google-data consent
`POST`	`/v1/me/monitoring/consent`	0	Accept or withdraw it (Dashboard session only)
`GET`	`/v1/me/monitoring/events`	0	Who created, changed, paused, or deleted which monitor

Backlink tools are enabled by default. Deployments can disable both as an operational kill switch, so use /v1/capabilities as the live source of truth.