redf0x1redf0x1/camofox-browser/.cursor/rules/020-api-endpoints.mdc

camofox-browser / rules

Cursor rule438 starsChanged 8 months agoMITView on GitHub

camofox-browser REST API endpoint reference — all endpoints on port 9377

Reads credentials

Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 4,181 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository14 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/001-camofox-core.mdcCursor rule
- .cursor/rules/010-cli-commands.mdcCursor rule
- .cursor/rules/030-workflows.mdcCursor rule
- .cursor/rules/040-anti-patterns.mdcCursor rule
- .cursor/rules/050-cli-dev.mdcCursor rule
- .cursor/rules/060-routes-dev.mdcCursor rule
- .cursor/rules/070-search-macros-presets.mdcCursor rule
- camofox-browserSkill
- camofox-cliSkill
- dogfoodSkill
- gemini-imageSkill
- redditSkill

The file

We split this 020-api-endpoints.mdc into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
If CAMOFOX_API_KEY is set, cookie import/export and evaluate routes require Authorization: Bearer <key>.
line 69
Very specific:
If keys are unset, routes are open except OpenClaw POST /stop, which still requires x-admin-key.
line 71

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

020-api-endpoints.mdc

---
description: "camofox-browser REST API endpoint reference — all endpoints on port 9377"
alwaysApply: false
---

# REST API Endpoints (Source-Verified)

Base URL: `http://localhost:9377`

## Core (`src/routes/core.ts`)

| Method | Endpoint |
|---|---|
| POST | `/sessions/:userId/cookies` |
| GET | `/tabs/:tabId/cookies` |
| GET | `/health` |
| GET | `/presets` |
| POST | `/tabs` |
| GET | `/tabs` |
| POST | `/tabs/:tabId/navigate` |
| GET | `/tabs/:tabId/snapshot` |
| POST | `/tabs/:tabId/wait` |
| POST | `/tabs/:tabId/click` |
| POST | `/tabs/:tabId/type` |
| POST | `/tabs/:tabId/press` |
| POST | `/tabs/:tabId/scroll` |
| POST | `/tabs/:tabId/scroll-element` |
| POST | `/tabs/:tabId/evaluate` |
| POST | `/tabs/:tabId/evaluate-extended` |
| POST | `/tabs/:tabId/back` |
| POST | `/tabs/:tabId/forward` |
| POST | `/tabs/:tabId/refresh` |
| GET | `/tabs/:tabId/links` |
| GET | `/tabs/:tabId/screenshot` |
| GET | `/tabs/:tabId/stats` |
| DELETE | `/tabs/:tabId` |
| DELETE | `/tabs/group/:listItemId` |
| DELETE | `/sessions/:userId` |
| POST | `/sessions/:userId/toggle-display` |
| GET | `/tabs/:tabId/downloads` |
| GET | `/users/:userId/downloads` |
| GET | `/downloads/:downloadId` |
| GET | `/downloads/:downloadId/content` |
| DELETE | `/downloads/:downloadId` |
| POST | `/tabs/:tabId/extract-resources` |
| POST | `/tabs/:tabId/batch-download` |
| POST | `/tabs/:tabId/resolve-blobs` |

## OpenClaw (`src/routes/openclaw.ts`)

| Method | Endpoint |
|---|---|
| GET | `/` |
| POST | `/tabs/open` |
| POST | `/start` |
| POST | `/stop` |
| POST | `/navigate` |
| GET | `/snapshot` |
| POST | `/act` |

## Common Request Patterns

- Tab-targeted routes require user-scoped lookup (`tabId` + `userId`).
- Snapshot/click/type/press/scroll are intended to run in a loop with fresh refs.
- `navigate` supports direct URL or macro expansion (`macro` + `query`).

## Auth Rules

- If `CAMOFOX_API_KEY` is set, cookie import/export and evaluate routes require `Authorization: Bearer <key>`.
- OpenClaw `POST /stop` always requires `x-admin-key` and compares it to configured admin key value.
- If keys are unset, routes are open except OpenClaw `POST /stop`, which still requires `x-admin-key`.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free