# RunPane API docs

The RunPane website API gives agents public product context. It doesn't create panes or read local repos. Use the local [`runpane` CLI](/docs/runpane-cli) or Pane's [MCP server](/docs/mcp) for that.

<a id="start-here"></a>

Every endpoint is a `GET` that needs no key ([auth](/docs/auth)) and returns Markdown, JSON or a redirect with a fixed shape. The full contract is the [OpenAPI document](https://runpane.com/openapi.json). Every operation in it has an `operationId` and typed parameters and responses, so you can turn them into function calls without guessing field names.

<a id="response-formats"></a>

## What you can ask

| You ask | Request | You get |
| --- | --- | --- |
| "Does Pane support Codex?" | `/ask-pane?query=does+pane+support+codex` | A short answer with links to matching pages. Add `&format=json` for JSON. See [Ask Pane](/docs/ask-pane). |
| "Give me Pane's docs in one file." | `/llms-full.txt` | All product context as Markdown. `/llms.txt` is the short index. |
| "How should an agent use Pane?" | `/agents.md` | Agent instructions. `/index.md` is the homepage, `/pricing.md` is pricing. |
| "Which `runpane` commands exist?" | `/runpane-cli-contract.json` | Every command's summary and usage, plus every flag. |
| "Where's the latest Mac download?" | `/api/download?version=latest&platform=macos&arch=arm64&format=dmg` | A `302` to the file on GitHub Releases. With `Accept: application/json`, `{"location": "..."}`. |
| "How many downloads does Pane have?" | `/api/badge/downloads` | A [Shields.io](https://shields.io) badge. `/api/badge/installs` counts installs that opened Pane in the last 30 days, excluding installs with analytics off. |
| "Who's on the leaderboard?" | `/api/runpane/leaderboard` | The top 100 opted-in users by estimated API cost over 30 days. |

All paths are on `https://runpane.com`. The OpenAPI document also lists the `/.well-known/` discovery files.

## Download parameters

`/api/download` takes all four of these, or none (which redirects to the latest releases page):

| Parameter | Values |
| --- | --- |
| `version` | A release tag, or `latest` |
| `platform` | `macos`, `windows` or `linux` |
| `arch` | `x64` or `arm64`, on every platform |
| `format` | `dmg` or `zip` on macOS, `exe` on Windows, `appimage` or `deb` on Linux |

An unsupported combination, such as `platform=windows` with `format=dmg`, returns `400`. The endpoint doesn't check that a release exists, so a valid combination for a missing version redirects to a GitHub URL that returns 404.

## Limits

- Ask Pane questions can be up to 500 characters. Longer returns `400`. Empty returns usage instructions.
- Don't send secrets, credentials, personal data or private code in a question.
- `RateLimit-Policy: 120;w=60` asks you to stay under 120 requests a minute. It's advisory. Nothing returns `429` today.

## Versioning and deprecation

The current API version is `2026-07-09`. Responses include `API-Version` and `RunPane-API-Version` headers. You don't need to send a version header.

Additive changes stay on the current paths. A breaking API gets a new path version, such as `/v2`. Unversioned paths point to the current version.

When we retire an old path:

1. We send a `Deprecation` header.
2. We send a `Sunset` header with the retirement date.
3. We send a `Link` header to the migration guide.
4. We give you at least 90 days of notice before the Sunset date.

Current endpoints aren't deprecated.
