Agent skill

API Mapping

by vellum-ai in vellum-ai/vellum-assistant

Record and analyze API surfaces of web services. An agent skill from vellum-ai/vellum-assistant.

MITAuto-check passedProductivity & Automation

Install API Mapping

skills CLI
$ npx skills add vellum-ai/vellum-assistant --skill api-mapping -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install vellum-ai/vellum-assistant api-mapping --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/vellum-ai/vellum-assistant.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/api-mapping .claude/skills/api-mapping && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-mapping
GitHub stars
1.4k
Token cost
~993 tokens
SKILL.md length
511 words
Files
2 (incl. assets)
Skills in repo
108
Repo updated
First seen
Licence
MIT

At a glance

Record and analyze API surfaces of web services. An agent skill from vellum-ai/vellum-assistant.

  • Works in 6 steps: Ask about the objective - Ask the user:… → Choose mode - Ask the user: "Should I… → Run the mapping - Execute the… → …
  • Productivity & Automation work in your project
  • SKILL.md covers CLI Setup, Typical Flow, Important Behavior and Command Reference
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Mapping is an agent skill from vellum-ai/vellum-assistant. Record and analyze API surfaces of web services

Its SKILL.md is about 990 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including assets. Compatibility notes: Designed for Vellum personal assistants

It sits in Productivity & Automation. The repository describes itself as: An AI Assistant that’s easy to setup, does your work 24/7, knows your preferences and gets better over time. The licence is MIT.

When your agent uses it

  • Productivity & Automation work in your project

Example prompts

  • “/api-mapping”

Requirements

  • Compatibility (from SKILL.md): Designed for Vellum personal assistants

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  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…
  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…
  3. Run the mapping - Execute the appropriate map command
  4. Wait for recording to complete - In auto mode, the CLI will browse and record for the default duration (60 seconds) then stop. In manual…
  5. Analyze the API map - Review the output and present findings to the user
  6. Offer next steps - Based on the discovered API surface, offer to

What it can do on your machine

Read from SKILL.md and the folder at commit 844117a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Designed for Vellum personal assistants

    From compatibility in the SKILL.md frontmatter.

Context cost

API Mapping loads about 993 tokens when it runs. Until then it costs about 15 tokens; SKILL.md has 511 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~15
When it runs · the whole SKILL.md, loaded when a task matches
~993

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from vellum-ai/vellum-assistant at commit 844117a, republished under its MIT licence (© vellum-ai). 511 words, ~993 tokens.

Download SKILL.mdSave it as .claude/skills/api-mapping/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
api-mapping
description
Record and analyze API surfaces of web services
compatibility
Designed for Vellum personal assistants
metadata.icon
assets/icon.svg
metadata.emoji
🗺️

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> --duration 120 --json
  4. Wait for recording to complete - In auto mode, the CLI will browse and record for the default duration (60 seconds) then stop. In manual mode, the CLI blocks until the user closes the browser or presses Ctrl+C. The command outputs a JSON summary of all discovered endpoints.

  5. Analyze the API map - Review the output and present findings to the user:

    • List discovered endpoints grouped by resource type (e.g., /api/v1/users, /api/v1/documents)
    • Note authentication patterns (Bearer tokens, cookies, API keys)
    • Identify CRUD operations and their HTTP methods
    • Highlight any WebSocket or streaming endpoints
    • Call out rate limiting headers or pagination patterns
  6. Offer next steps - Based on the discovered API surface, offer to:

    • Create CLI tools that wrap the discovered endpoints
    • Generate TypeScript types from observed request/response payloads
    • Build a focused integration for the user's specific use case
    • Re-record with a longer duration or manual mode to capture more endpoints
Show full SKILL.md (111 more words)Show less

Important Behavior

  • Be proactive. If the user names a service, start mapping immediately rather than asking unnecessary clarifying questions. Ask about mode preference, then go.
  • Always use --json flag on all commands for reliable parsing.
  • Present findings clearly. Group endpoints logically, show HTTP methods, and highlight the most useful ones for the user's stated objective.
  • Suggest manual mode for authenticated services. If auto mode returns mostly auth redirects or login pages, suggest switching to manual mode so the user can log in first.
  • Handle errors gracefully. If the domain is unreachable or the recording captures no API calls, suggest checking the domain, trying manual mode, or increasing the duration.

Command Reference

map <domain> --json                        # Auto mode: browse and record API calls (default 60s)
map <domain> --manual --json               # Manual mode: user drives the browser, CLI records
map <domain> --duration <secs> --json      # Auto mode with custom duration
map <domain> --manual --duration <secs> --json  # Manual mode with custom timeout

© vellum-ai, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (assets) in skills/api-mapping of vellum-ai/vellum-assistant.

  • SKILL.md
  • assets/icon.svg

Open the folder on GitHubat commit 844117a

Compare with similar skills

API Mapping next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Mapping compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Mapping this skillvellum-ai/vellum-assistant1.4k—~993Automated safety check: PassMIT
Agent Browserquran/quran.com-frontend-next1.9k40 repos~3.3kAutomated safety check: PassNone
Perform Tasktelegramdesktop/tdesktop33k2 repos~3kAutomated safety check: PassGPL-3.0
Dependency Watchtelegramdesktop/tdesktop33k—~2.2kAutomated safety check: PassGPL-3.0
Brave Searchbadlogic/pi-skills2.6k5 repos~592Automated safety check: PassMIT
Garden Inboxpaperclipai/paperclip99k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Agent Browser

    quran/quran.com-frontend-next

    Automates browser interactions for web testing, form filling, screenshots, and data extraction.

    1.9k GitHub starsUsed in 40 repos~3.3k tokens
    Productivity & AutomationAuto-check passed
  • Perform Task

    telegramdesktop/tdesktop

    Resolve, start or resume, implement, review, test, and publish exactly one existing ai-tdesktop task by short slug or full dated id, including rare blocked retries and split-required results.

    33k GitHub starsUsed in 2 repos~3k tokens
    Productivity & AutomationAuto-check passed
  • Dependency Watch

    telegramdesktop/tdesktop

    Audit Telegram Desktop dependencies on freshly fetched origin/dev for releases and security fixes, including upstream lag and backport candidates in patched forks.

    33k GitHub stars~2.2k tokensUpdated today
    Productivity & AutomationAuto-check passed
  • Brave Search

    badlogic/pi-skills

    Web search and content extraction via Brave Search API. An agent skill from badlogic/pi-skills.

    2.6k GitHub starsUsed in 5 repos~592 tokens
    Productivity & AutomationAuto-check passed
  • Garden Inbox

    paperclipai/paperclip

    Scan a Paperclip user's Mine inbox, classify reversible archive candidates, request checkbox confirmation, and archive only accepted selections.

    99k GitHub stars~1.1k tokensUpdated today
    Productivity & AutomationAuto-check passed
  • Continue

    telegramdesktop/tdesktop

    Continue autonomous Telegram Desktop development from the shared ai-tdesktop repository.

    33k GitHub starsUsed in 2 repos~9.4k tokens
    Productivity & AutomationAuto-check passed

More from vellum-ai/vellum-assistant

All 108 skills in this repo
  • Vellum GitHub App Setup

    vellum-ai/vellum-assistant

    Create and configure a GitHub App so the assistant can push commits, open PRs, and comment under its own bot identity.

    1.4k GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Discord App Setup

    vellum-ai/vellum-assistant

    Connect a Discord bot to the assistant via the Discord Gateway with guided application creation and intent configuration

    1.4k GitHub stars~4.2k tokensUpdated today
    Auto-check passed
  • Sentry App Setup

    vellum-ai/vellum-assistant

    Create and configure a Sentry internal integration so the assistant can manage issues, alerts, and releases under its own identity

    1.4k GitHub stars~1.3k tokensUpdated today
    Auto-check passed
  • Memory Corpus Ingest

    vellum-ai/vellum-assistant

    Ingest a large dataset into memory as a skimmed map. An agent skill from vellum-ai/vellum-assistant.

    1.4k GitHub stars~3k tokensUpdated today
    Auto-check: notes
  • Plugin Builder

    vellum-ai/vellum-assistant

    A skill your agent uses when the user wants to build, scaffold, ship, or edit a Vellum plugin that bundles multiple surfaces (hooks, tools, skills, and more) into one installable package.

    1.4k GitHub stars~3.1k tokensUpdated today
    Auto-check passed
  • Slack App Setup

    vellum-ai/vellum-assistant

    Connect a Slack app to the Vellum Assistant via Socket Mode.

    1.4k GitHub stars~2.5k tokensUpdated today
    Auto-check: warnings

Questions about API Mapping

What does API Mapping do?

Record and analyze API surfaces of web services. An agent skill from vellum-ai/vellum-assistant. API Mapping is an agent skill from vellum-ai/vellum-assistant.

When should I use API Mapping?

API Mapping fits situations like: productivity & Automation work in your project.

How do I install API Mapping in Claude Code?

Run `npx skills add vellum-ai/vellum-assistant --skill api-mapping -a claude-code`. Or copy the skill folder (skills/api-mapping in vellum-ai/vellum-assistant) into .claude/skills/api-mapping in your project. Claude Code loads it when a task matches its description.

How do I install API Mapping in Codex?

Run `npx skills add vellum-ai/vellum-assistant --skill api-mapping -a codex`. Or copy the skill folder (skills/api-mapping in vellum-ai/vellum-assistant) into .agents/skills/api-mapping in your project. Codex loads it when a task matches its description.

Can I use API Mapping in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add vellum-ai/vellum-assistant --skill api-mapping -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-mapping, .gemini/skills/api-mapping, .github/skills/api-mapping and .opencode/skills/api-mapping in your project.

What does API Mapping need to run?

SKILL.md names no scripts, command-line tools or credentials: API Mapping is instructions for the agent only. Compatibility (from SKILL.md): Designed for Vellum personal assistants.

Does API Mapping access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Mapping safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Mapping use?

API Mapping is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Mapping use?

About 993 tokens (SKILL.md is roughly 4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Mapping?

Skills that share tags, products or a category with API Mapping: Agent Browser (quran/quran.com-frontend-next, 1.9k stars), Perform Task (telegramdesktop/tdesktop, 33k stars), Dependency Watch (telegramdesktop/tdesktop, 33k stars) and Brave Search (badlogic/pi-skills, 2.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Mapping?

vellum-ai (a GitHub organization) maintains it in vellum-ai/vellum-assistant, which has 1,400 GitHub stars. The repository holds 108 skills in this directory. The repository was last updated on October 9, 2026.

Source: vellum-ai/vellum-assistant on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.