api-mapping

Featured

Record and analyze API surfaces of web services

AI & Automation 1,231 stars 174 forks Updated today MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

You can record and analyze the API surface of any web service using the `map` CLI. ## CLI Setup **IMPORTANT: Always use `host_bash` (not `bash`) for all `map` commands.** The API mapping CLI needs host access for Chrome CDP, network recording, and browser automation - none of which are available inside the sandbox. `map` is a CLI tool that should be available on your PATH. Do NOT search for the binary or try to discover how the CLI works. Just run the commands as documented below. ## Typical Flow When the user wants to map a web service's API (e.g. "Map the Notion API" or "Figure out how Figma's API works"): 1. **Ask about the objective** - Ask the user: "What service do you want to map?" and "What are you trying to build or integrate with?" This helps focus the recording on the relevant parts of the API surface. 2. **Choose mode** - Ask the user: "Should I browse automatically, or do you want to drive?" This determines whether to use auto mode or manual mode: - **Auto mode**: The CLI launches a headless browser, navigates the service, and records API calls automatically. Best for broad discovery. - **Manual mode**: A Chrome window opens for the user to interact with the service while the CLI records all API traffic in the background. Best for capturing a specific workflow. 3. **Run the mapping** - Execute the appropriate `map` command: - Auto mode: `map <domain> --json` - Manual mode: `map <domain> --manual --json` - For longer sessions: `map <domain> ...

Details

Author
vellum-ai
Repository
vellum-ai/vellum-assistant
Created
7 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category