> ## Documentation Index
> Fetch the complete documentation index at: https://openrush.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint index

> Developer index of public OpenRush API endpoints.

This page lists the public endpoints developers can call directly. Most non-technical users should start with [Get started](/quickstart) or [Connect an AI agent](/guides/mcp).

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`            |       3 | Starting map for one domain                          |
| `POST` | `/v1/tools/discover_competitors`      |       5 | Find organic competitors                             |
| `POST` | `/v1/tools/research_keywords`         |       3 | Expand a seed term into keyword ideas                |
| `POST` | `/v1/tools/compare_keyword_coverage`  |       5 | Find keyword gaps against competitors                |
| `POST` | `/v1/tools/inspect_serp`              |       2 | Fetch a live SERP snapshot                           |
| `POST` | `/v1/tools/inspect_search_visibility` |       3 | Check ranking positions across keywords              |
| `POST` | `/v1/tools/audit_site`                |      10 | Audit sampled pages for technical and content issues |
| `POST` | `/v1/tools/inspect_keyword`           |       2 | Drill into one keyword                               |
| `POST` | `/v1/tools/inspect_page`              |       2 | Drill into one URL                                   |
| `POST` | `/v1/tools/export_dataset`            |       0 | Fetch full rows from an `openrush://` resource       |

<Note>
  Only build against endpoints listed here or returned by `/v1/capabilities` for your account.
</Note>