Showing the first 18000 characters. Load the complete file to read the remainder.
# Postman Docs
> Official documentation for Postman, the API platform for building, testing, documenting, monitoring, and governing APIs. Covers the desktop and web app, the Postman CLI for coding agents and CI, collections, mock servers, monitors, Spec Hub, Flows, SDK generation and the Postman API.
- Every page is available as clean Markdown: append `.md` to its URL.
- Current docs live under /docs/ and are version 12 (latest). Version 11 docs are under /v11/.
- Coding agents can use Postman without the desktop app through the Postman CLI. Start with the CLI overview and the agents-and-CI guide.
- For AI client integration with the Postman Docs, connect to the Postman Docs MCP server at https://learning.postman.com/_mcp/server.
## Get started
- [Get started in Postman](https://learning.postman.com/docs/getting-started/overview.md): Overview of what Postman is and where to start in the documentation.
- [Postman quick start](https://learning.postman.com/docs/getting-started/quick-start.md): Learn how to use Postman's API client to create and send API requests.
- [Postman basics](https://learning.postman.com/docs/getting-started/basics/postman-basics.md): Core Postman features for sending requests, sharing work and using Postman in API development workflows.
- [Install Postman](https://learning.postman.com/docs/getting-started/installation/overview.md): Installation options for the Postman desktop and web apps.
- [Postman system requirements](https://learning.postman.com/docs/getting-started/installation/system-requirements.md): System requirements for the Postman desktop app on Windows, Mac, and Linux.
- [Sign up for Postman](https://learning.postman.com/docs/getting-started/installation/account/sign-up-for-postman.md): Create a Postman account and sign in.
- [About Postman AI features](https://learning.postman.com/docs/getting-started/basics/about-ai.md): Postman's AI features enable you to perform tasks faster, automate your workflows, and build your own AI models.
- [About Agent Mode](https://learning.postman.com/docs/getting-started/basics/about-agent-mode.md): Agent Mode is Postman's AI assistant: describe a task in plain language to send requests, fix errors, update tests and build Flows.
- [Import data into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting/importing-data.md): Import collections, API specifications and other files into Postman.
- [Migrate from other API clients](https://learning.postman.com/docs/getting-started/importing-and-exporting/migrate-from-other-clients.md): Move your work from other API clients into Postman.
- [Troubleshoot your Postman installation](https://learning.postman.com/docs/getting-started/installation/troubleshoot.md): Fixes for problems installing and running the Postman desktop app.
## Postman CLI and coding agents
- [Postman CLI overview](https://learning.postman.com/docs/postman-cli/postman-cli-overview.md): Learn what the Postman CLI is and explore the features of Postman's secure, signed command-line tool.
- [Install the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-installation.md): Install, update, or uninstall the Postman CLI on Windows, macOS, or Linux using npm or a platform-specific installer.
- [Postman CLI authentication and configuration](https://learning.postman.com/docs/postman-cli/postman-cli-authenticate-and-configure.md): Learn how Postman CLI credentials, regions, and local project files work together, including credential precedence, guest sessions, and the local-vs-cloud mode rule.
- [Use the Postman CLI with AI agents and CI/CD](https://learning.postman.com/docs/postman-cli/postman-cli-agents-and-ci.md): Run the Postman CLI non-interactively in scripts, CI/CD pipelines, and coding agents, with machine-readable output, exit codes, and links to Postman's other agent integrations.
- [Postman CLI skills commands `(postman skills)`](https://learning.postman.com/docs/postman-cli/postman-cli-skills.md): Check the status of and update Postman CLI agent skills using skills status and update commands.
- [Postman CLI init command `(postman init)`](https://learning.postman.com/docs/postman-cli/postman-cli-init.md): Use the CLI init command to scaffold a new Postman project and install agent skills for coding agents.
- [Run a collection using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-collection.md): Run a Postman collection locally or in CI/CD pipelines using the Postman CLI, then send the test results to Postman.
- [Run a monitor using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-monitor.md): Trigger a Postman monitor run in your CI/CD pipeline with the Postman CLI to catch regressions before you deploy.
- [Configure and validate performance tests using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-performance-test.md): Configure and run Postman performance tests locally, in CI/CD, or on Postman's cloud infrastructure, then view the results.
- [Run Postman CLI commands in your CI/CD workflows using GitHub Actions](https://learning.postman.com/docs/postman-cli/postman-cli-github-actions.md): Run Postman CLI commands in GitHub Actions to run collections and monitors, check syntax, and validate specs in your CI/CD workflow.
- [Postman CLI commands and options overview](https://learning.postman.com/docs/postman-cli/postman-cli-options.md): Browse all Postman CLI command categories, including collections, environments, teams, and workspaces, in one reference.
- [Generate collection run reports using the Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-reporters.md): Generate CLI, JSON, JUnit, or HTML reports for Postman collection runs, and configure options for one or more reporters.
- [Postman CLI mock commands `(postman mock)`](https://learning.postman.com/docs/postman-cli/postman-cli-mock.md): Run, generate, retrieve, list, and delete Postman mock servers from the command line using mock commands.
- [Postman CLI simulation commands `(postman simulation)`](https://learning.postman.com/docs/postman-cli/postman-cli-simulator.md): Create, run, push, deploy, and delete simulations that serve several mocks behind one address, using simulation commands.
- [Postman CLI secret commands `(postman secret)`](https://learning.postman.com/docs/postman-cli/postman-cli-secrets.md): Create secrets in your team's Postman Shared Vault from the command line with secret commands.
- [Postman CLI spec commands `(postman spec)`](https://learning.postman.com/docs/postman-cli/postman-cli-governance.md): Lint, list, retrieve, create, and delete API specifications for governance checks using spec commands.
- [Postman CLI SDK commands `(postman sdk)`](https://learning.postman.com/docs/postman-cli/postman-cli-sdk-gen.md): Generate, track, list, and fetch client SDKs from Postman collections and API specs using SDK commands.
- [Postman CLI webhook commands `(postman webhook)`](https://learning.postman.com/docs/postman-cli/postman-cli-webhooks.md): Create, list, delete, start, pause, and check the status of Postman webhooks using webhook commands.
- [Postman CLI troubleshooting and FAQ](https://learning.postman.com/docs/postman-cli/postman-cli-troubleshooting.md): Answers to common Postman CLI problems and questions, including duplicate installations, Alpine Linux support, EU region limitations, and how it compares to Newman.
- [Migrate scripts from Newman to the Postman CLI](https://learning.postman.com/docs/reference/newman-cli/migrate-to-postman-cli.md): Convert Newman scripts to Postman CLI commands.
- [Postman plugin for coding agents](https://learning.postman.com/docs/postman-plugin/overview.md): Give Claude Code, Codex, Cursor, and other coding agents Postman's skills to build, test, and manage APIs without leaving your coding environment.
- [Install the Postman plugin](https://learning.postman.com/docs/postman-plugin/install/overview.md): Install the Postman plugin into every detected coding agent at once, into a single agent with its own method, or load skills with the Postman CLI.
- [Install the Postman plugin into detected agents](https://learning.postman.com/docs/postman-plugin/install/detected-agents.md): Install the Postman plugin into every coding agent detected on your machine with a single command, or limit the installation to one agent.
- [Install the Postman plugin for a specific agent](https://learning.postman.com/docs/postman-plugin/install/per-agent.md): Install the Postman plugin into Claude Code, Codex, Cursor, Factory, Kimi Code, OpenCode, or Pi using each agent's own marketplace or command.
- [Load skills with the Postman CLI](https://learning.postman.com/docs/postman-plugin/install/load-skills.md): As an alternative to the Postman plugin, load Postman's skills into your coding agent by running the Postman CLI postman init command.
- [Work with Postman from your agent](https://learning.postman.com/docs/postman-plugin/work-with-postman.md): After installing the Postman plugin, describe API tasks in natural language and let your coding agent build, test, mock, and monitor APIs with Postman.
- [Postman plugin skills](https://learning.postman.com/docs/postman-plugin/skills.md): The Postman plugin installs skills that teach your coding agent how to build, test, mock, monitor, document, and manage APIs with Postman.
## Send requests
- [Use Postman](https://learning.postman.com/docs/use/overview.md): Send API requests, organize collections, sync with Git, automate work with Agent Mode, query Context Graph, store secrets in Postman Vault, and capture API traffic.
- [Send API requests and get response data in Postman](https://learning.postman.com/docs/use/send-requests/requests.md): Build and send HTTP requests, inspect responses and iterate on API calls.
- [Send a request with the Postman API client](https://learning.postman.com/docs/use/send-requests/create-requests/request-basics.md): Create, send and share HTTP requests in the Postman API client.
- [API authentication and authorization in Postman](https://learning.postman.com/docs/use/send-requests/authorization/authorization.md): Postman enables you to send auth details with your API requests.
- [Authenticate with OAuth 2.0 authentication in Postman](https://learning.postman.com/docs/use/send-requests/authorization/oauth-20.md): Get an OAuth 2.0 access token and use it to authenticate requests.
- [Reuse data with variables and environments in Postman](https://learning.postman.com/docs/use/send-requests/variables/variables-intro.md): Define reusable values for requests and scripts with variables.
- [Group sets of variables in Postman using environments](https://learning.postman.com/docs/use/send-requests/variables/managing-environments.md): Environments can help you to collaborate on Postman data if you're working as part of a team.
- [API response structure in Postman](https://learning.postman.com/docs/use/send-requests/response-data/responses.md): The Postman response viewer helps you visualize and check the correctness of API responses.
- [Debug API requests in Postman](https://learning.postman.com/docs/use/send-requests/response-data/troubleshooting-api-requests.md): Troubleshoot API requests that fail or return unexpected results.
- [Other API protocols in Postman](https://learning.postman.com/docs/use/send-requests/protocols/protocols.md): Postman supports multiple API protocols beyond HTTP and REST.
- [GraphQL in Postman](https://learning.postman.com/docs/use/send-requests/protocols/graphql/graphql-overview.md): Send GraphQL queries and mutations from Postman.
- [Manage gRPC APIs using Postman](https://learning.postman.com/docs/use/send-requests/protocols/grpc/grpc-client-overview.md): Send gRPC requests from Postman using a service definition.
- [Create MCP requests and add them to your collections](https://learning.postman.com/docs/use/send-requests/protocols/mcp-requests/overview.md): Create requests that interact with a Model Context Protocol (MCP) server.
- [Create AI requests and add them to your collections](https://learning.postman.com/docs/use/send-requests/protocols/ai-requests/overview.md): Create requests that interact with an AI model.
## Collections and Git
- [Create and manage request collections in Postman](https://learning.postman.com/docs/use/use-collections/overview.md): Collections group related requests so you can organize, share and run them.
- [Create collections of API requests in Postman](https://learning.postman.com/docs/use/use-collections/create-collections.md): Create a collection of API requests.
- [Manage and organize Postman Collections](https://learning.postman.com/docs/use/use-collections/manage-collections.md): Save, organize and find requests in collections.
- [About Native Git](https://learning.postman.com/docs/use/native-git/overview.md): Use the Postman desktop app to access the Git-connected experience.
- [Set up Native Git](https://learning.postman.com/docs/use/native-git/setup.md): Connect a workspace to a Git project. Coding agents can run `postman init` instead of using the app.
- [Develop locally with Native Git](https://learning.postman.com/docs/use/native-git/develop-locally.md): Develop a feature locally in a workspace connected to a Git project.
- [Automate Native Git with CI/CD](https://learning.postman.com/docs/use/native-git/automation.md): Run Native Git workflows in CI/CD pipelines.
- [Store secrets in Postman Vault](https://learning.postman.com/docs/use/postman-vault/postman-vault-secrets.md): Availability of features on this page depend on your Postman plan.
## Tests, scripts and performance
- [Test APIs and write scripts in Postman](https://learning.postman.com/docs/tests-and-scripts/tests-and-scripts.md): Overview of testing APIs and writing scripts in Postman.
- [Use scripts to add logic and tests to Postman requests](https://learning.postman.com/docs/tests-and-scripts/write-scripts/intro-to-scripts.md): You can use the Postman runtime to write scripts that add dynamic behavior to requests and collections.
- [Write scripts to test API response data in Postman](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-scripts.md): Write post-response scripts that run JavaScript to assert on API response data.
- [Postman test script examples](https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-examples.md): Depending on your test logic and how you want to get the results, there are various ways to structure the test assertions in a test script.
- [Troubleshoot common test errors](https://learning.postman.com/docs/tests-and-scripts/write-scripts/troubleshoot-tests.md): When you encounter errors or unexpected behavior in your post-response scripts, the Postman Console can help you to identify the source.
- [Test APIs with datasets in Postman](https://learning.postman.com/docs/tests-and-scripts/datasets/overview.md): Datasets enable you to manage and reuse data across your API workflows.
- [Test API functionality and performance in Postman](https://learning.postman.com/docs/tests-and-scripts/test-apis/test-apis.md): Test API functionality and performance: integration, end-to-end, regression and performance testing.
- [Run and automate API tests in Postman](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests.md): Run API tests manually, on a schedule, with monitors or in CI/CD.
- [Run API tests in your CI/CD pipeline using Postman](https://learning.postman.com/docs/tests-and-scripts/run-tests/run-tests-with-ci-cd.md): Run Postman API tests in a CI/CD pipeline.
- [Test your API using the Collection Runner](https://learning.postman.com/docs/tests-and-scripts/running-collections/intro-to-collection-runs.md): Send some or all of the API requests in a Postman Collection using the Collection Runner.
- [Simulate user traffic to test your API performance](https://learning.postman.com/docs/tests-and-scripts/performance-testing/testing-api-performance.md): Test the performance of your APIs with Postman.
- [Configure and run performance tests in Postman](https://learning.postman.com/docs/tests-and-scripts/performance-testing/performance-test-configuration.md): Use the Collection Runner to test the performance of your API with the same requests and collections you use for functional API tests.
- [View failed test assertions for performance tests](https://learning.postman.com/docs/tests-and-scripts/performance-testing/test-assertions/overview.md): The Tests tab in your performance test results shows how your test assertions behave as load increases.
## Mock servers, specs and API design
- [Design and build your APIs in Postman](https://learning.postman.com/docs/design-apis/overview.md): Ways to design and develop APIs in Postman: collections, specifications and mock servers.
- [Simulate your API in Postman with a mock server](https://learning.postman.com/docs/design-apis/mock-apis/overview.md): Postman lets you simulate your API without a real backend using mocks and mock servers.
- [Deploy a mock server](https://learning.postman.com/docs/design-apis/mock-apis/set-up-mock-servers.md): Create a mock server in Postman to simulate a real API server that's always available to handle requests.
- [Build API mocks with JavaScript](https://learning.postman.com/docs/design-apis/mock-apis/local-mock-servers.md): How to use mocks, a code-based API simulator you build with custom JavaScript request handlers.
- [Generate dynamic mock server responses with variables](https://learning.postman.com/docs/design-apis/mock-apis/create-dynamic-responses.md): Return dynamic mock responses using variables. Applies to mock servers created from a collection.
- [Design API specifications in Postman](https://learning.postman.com/docs/design-apis/specifications/overview.md): Take an API-first approach to development with Spec Hub in Postman.
- [Create a new API specification](https://learning.pos
Measured from the saved file
Linked document
UTF-8 text size
29.6 KB30264 bytes
Token count
6567o200k_base encoding
Markdown links
144144 distinct URLs
Fenced code blocks
0197 lines in the file
Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.
Project H1
Postman Docs
Opening blockquote
Official documentation for Postman, the API platform for building, testing, documenting, monitoring, and governing APIs. Covers the desktop and web app, the Postman CLI for coding agents and CI, collections, mock servers, monitors, Spec Hub, Flows, SDK generation and the Postman API.
Context architecture
How the content is divided
15 H2 sections organize 144 parsed Markdown links. 139 links point to .md or .markdown paths; 4 link occurrences use another hostname. Linked destinations have not been recursively validated.
H2 section
Links
UTF-8 bytes
Tokens
Get startedLine 10
11
2057
462
Postman CLI and coding agentsLine 24
27
6577
1442
Send requestsLine 54
14
2831
618
Collections and GitLine 71
8
1371
302
Tests, scripts and performanceLine 82
13
2953
627
Mock servers, specs and API designLine 98
13
2679
568
MonitorsLine 114
8
1514
329
FlowsLine 125
5
898
206
API governance and catalogLine 133
5
1078
221
Documentation and publishingLine 141
6
1318
266
SDK and CLI generatorsLine 150
6
1144
243
Postman API and developer toolsLine 159
7
1251
269
Collaboration and integrationsLine 169
8
1635
351
Administration, billing and securityLine 180
8
1330
295
OptionalLine 191 · Optional
5
495
128
Nested indexes
1 distinct links point to other llms.txt paths. These are routes to more indexes, not proof their contents were included in this file.
Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.
Embedded material
Code, installation and API examples
Fenced blocks
0 closed
Declared languages
No fenced blocks detected
Package-install commands
0 detected in fenced or inline code
Authentication examples
0 fenced lines match API-key, Authorization, Bearer, OAuth or access-token patterns
HTTP request examples
0 fenced lines match request-method patterns
Authentication links
2 links have authentication-related labels
Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.
Publisher prioritization
The Optional section
1 H2 section named “Optional” contain 5 parsed links. 139 links sit outside those sections. That puts 3.5% of the file’s parsed links under Optional.
The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.
Machine-readable routes
MCP references and configuration text
MCP-related text was detected in the captured file. 1 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.
A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.
Change evidence
What can be said about freshness
This capture establishes a baseline. Update frequency cannot be determined from one observation.
Linked release and migration material
1 links have release, changelog, deprecation or migration terms in their labels or paths. These provide places to investigate product changes separately.
File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.
Counts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.