Your progress is only saved in this browser. to protect it and pick up on any device.

Connect a Postman API key to check your work

You do each step in Postman, then LiftOff uses your key to look at your workspace and confirm it's done. Connect once and it works for every module. Your key is saved in this browser and is only used to check your work in Postman.

0 of 3 steps0%
1

Pick Up Where the CLI Left Off

This module doesn't start from scratch. It continues the postman-terminal-demo repo from the Postman CLI module, which already holds your spec, collection, environment, mock and a bound workspace. This step confirms that foundation is in place so the agent has real work to build on.

  1. Open a terminal in the repo and make sure everything from the CLI module is pushed:

    zsh — ~/postman-terminal-demo
    cd postman-terminal-democd postman-terminal-demo
    git statusgit status
    git pullgit pull
    # read the workspace id from the binding
    WS_ID=$(awk '/^workspace:/{w=1} w && /id:/{print $2; exit}' .postman/resources.yaml)WS_ID=$(awk '/^workspace:/{w=1} w && /id:/{print $2; exit}' .postman/resources.yaml)
    postman workspace get "$WS_ID"postman workspace get "$WS_ID"
    0/5 run
  2. Enter your GitHub username below, then click Validate. LiftOff checks your Postman API key, finds the public repo, and confirms it holds openapi.yaml, a collection, the committed agent skills and a workspace binding that belongs to you.

Troubleshooting: If a file is reported missing, finish the matching step in the Postman CLI module, then git push and validate again. The repo must be public.

2

Install the Postman Plugin

In the CLI module you typed every command yourself. The Postman plugin gives your coding agent the same abilities: skills for designing, mocking, testing, documenting and shipping APIs, plus a fallback to Postman's hosted MCP server when the CLI can't run. It works in Claude Code, Cursor, Codex, GitHub Copilot CLI and several other agents.

  1. Install it in every compatible agent on your machine with one command:

    zsh — ~/postman-terminal-demo
    npx @postman/postman-pluginnpx @postman/postman-plugin
    # see what was installed
    npx @postman/postman-plugin statusnpx @postman/postman-plugin status
    0/2 run

    Prefer to install into one agent? Use the command for yours:

    AgentInstall
    Claude Codeclaude plugin marketplace add anthropics/claude-plugins-official then claude plugin install postman@claude-plugins-official
    Cursor/add-plugin postman inside Cursor
    Codexcodex plugin marketplace add postmanlabs/postman-plugin then codex plugin add postman@postman
    GitHub Copilot CLIcopilot plugin marketplace add postmanlabs/postman-plugin then copilot plugin install postman@postman

    The plugin README lists the rest, including Antigravity, Factory Droid, Kimi Code, OpenCode and Pi.

  2. Start your agent from the repo root so it can see AGENTS.md and the postman/ folder. If your agent needs to sign in to Postman's MCP server, it will prompt you (for example with /mcp).

    zsh — ~/postman-terminal-demo
    claudeclaude
    0/1 run

    Swap claude for the command that starts your agent.

  3. Check the plugin is loaded by asking:

    Your coding agent — ~/postman-terminal-demo

    Which Postman skills do you have available?

    I have the Postman plugin loaded. Skills available:
    • api-engineer: design, build and ship APIs
    • api-mocking, api-testing, api-monitoring
    • ci-integration, variables, api-documentation
    Paste this into your agent · reply shown is an example, yours will differ

    You should see skills such as api-engineer, api-mocking, api-testing and ci-integration.

Click Done when your agent lists the Postman skills.

3

Let the Agent Find Its Bearings

A coding agent is only as good as the context it has. Your repo carries that context in files: AGENTS.md, the committed skills, .postman/resources.yaml and your spec. This step is about watching the agent read them, so you can trust what it does next.

  1. Ask your agent to orient itself. Don't tell it which commands to run:

    Your coding agent — ~/postman-terminal-demo

    Look at this repo and tell me what you find. Which Postman workspace is it bound to, what API does `openapi.yaml` describe, and what is in the `postman/` folder? Don't change anything.

    Paste this into your agent
  2. Check the answer against what you built. It should name your workspace, the Tasks API with its three operations, the collection, the Local environment and the mock. If it reaches for the CLI to check, such as postman workspace get, that is the plugin's skills at work.

Click Done when the agent's answer matches your repo.