For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Postman
PricingEnterprise
Contact SalesSign InSign Up for Free
HomeDocs
HomeDocs
      • Overview
        • Overview
        • Get started
        • Run tasks with AI Skills
        • Agent Mode Enterprise
        • Use Postman AI Recipes
        • Troubleshoot Agent Mode
  • Welcome
  • Postman quick start
  • Overview
  • The Postman interface
  • Postman elements
  • The Postman Agent
  • Postman AI features
  • Agent Mode
  • Syncing
  • Lightweight API Client
  • Scratch Pad
  • Overview
  • System requirements
  • Install the Postman app
  • Update Postman
  • Firewall configuration
  • Troubleshooting
  • Overview
  • General settings
  • Working directory
  • Themes
  • Shortcuts
  • AI
  • Data
  • Add-ons
  • Certificates
  • Connected accounts
  • Proxy
  • Overview
  • Sign up and sign in
  • Manage your account
  • Manage account settings
  • Customize your profile
  • Proxy server configuration
  • Overview
  • FAQ
  • Overview
  • Data import methods
  • SoapUI import
  • Hoppscotch import
  • Insomnia import
  • Thunder Client import
  • Git import
  • New Relic import
  • cURL command import
  • Swagger API import
  • Data export
  • Troubleshooting
  • Feature Spotlight
  • August 1, 2026
  • Overview
  • Overview
  • Overview
  • Request basics
  • Parameters and body data
  • Request headers
  • Test data storage
  • Customize request settings
  • Group requests in collections
  • Generate client code
  • Overview
  • Add certificates
  • Request authorization
  • Public API authorization
  • Authorization types
  • Digest
  • OAuth 1.0
  • OAuth 2.0
  • Hawk
  • AWS Signature
  • NTLM
  • Akamai Edgegrid
  • ASAP (Atlassian)
  • Overview
  • API response structure
  • Visualize request responses
  • Create request response examples
  • Create and send cookies
  • Debug requests
  • Overview
  • Store values in variables
  • Share variables
  • Create and use environments
  • Set environment variables
  • Manage team environments
  • Environment colors
  • Pinned environments
  • Overview
  • Overview
  • Create AI requests
  • Add MCP servers
  • Interact with AI models
  • Manage AI request settings
  • Overview
  • Create GraphQL requests
  • The GraphQL interface
  • Other GraphQL requests
  • Overview
  • The gRPC interface
  • Invoke a gRPC request
  • Manage gRPC service definitions
  • Test gRPC requests
  • gRPC mock servers
  • gRPC request-response examples
  • gRPC protobuf types
  • Overview
  • Create MCP requests
  • Interact with MCP servers
  • Manage MCP request settings
  • Debug OAuth 2.1 authentication
  • Add servers to MCP hosts
  • Overview
  • Manage MQTT requests
  • Create an MQTT request
  • Send SOAP requests
  • Send requests to Unix sockets or named pipes
  • Webhooks
  • Overview
  • Create a WebSocket request
  • Create a Socket.IO request
  • Work with WebSocket messages
  • Listen to Socket.IO events
  • Use variables in WebSocket requests
  • Add details to a WebSocket request
  • Save WebSocket requests
  • Document WebSocket requests
  • Troubleshoot WebSocket requests
  • Overview
  • Create collections
  • Add requests to collections
  • Manage and organize collections
  • Collaborate with collections
  • View collection activity and elements
  • About collection schemas
  • Overview
  • Set up Native Git
  • Develop locally
  • Collaborate with your team
  • Share local changes
  • Automate with CI/CD
  • Overview
  • Get started
  • Run tasks with AI Skills
  • Agent Mode Enterprise
  • Use Postman AI Recipes
  • Troubleshoot Agent Mode
  • Overview
  • Get started
  • Automations
  • Overview
  • Access Postman Vault
  • Create vault secrets
  • Use vault secrets
  • Export and import vault secrets
  • Integrations overview
  • 1Password
  • AWS Secrets Manager
  • Azure Key Vault
  • HashiCorp Vault
  • Manage integrations
  • Troubleshoot vault secrets
  • Overview
  • Capture traffic with Postman proxy
  • Capture HTTP requests
  • Capture HTTPS traffic
  • Capture traffic with Postman Interceptor
  • Overview
  • Inspect network traffic
  • Automate web applications
  • Sync cookies
  • Overview
  • Overview
  • Write pre-request scripts
  • Write tests
  • Overview
  • Reuse internal scripts
  • Use packages from external registries
  • Script examples
  • Dynamic variables
  • Overview
  • pm variables methods
  • pm.vault
  • pm.cookies
  • pm.request
  • pm.response
  • pm.sendrequest
  • pm.visualizer
  • pm.test and pm.expect
  • pm.require
  • pm.execution
  • pm.message
  • pm.info
  • pm.mock
  • pm.datasets
  • pm.state
  • Troubleshoot test errors
  • Overview
  • Create datasets
  • Manage datasets
  • Use datasets
  • Example dataset views
  • Overview
  • Integration testing
  • End-to-end testing
  • Regression testing
  • Performance testing
  • Overview
  • Run tests manually
  • Run tests on a schedule
  • Run tests in CI/CD pipelines
  • Run tests with monitors
  • Overview
  • Integrate your test suite
  • Application testing FAQs
  • Overview
  • Collection Runner
  • Automate collection runs
  • View scheduled collection runs
  • Run collection with simulated failures
  • Schedule collection runs with monitors
  • Trigger collection runs
  • Customize collection run order
  • Run a collection with imported data
  • Overview
  • Run a collection
  • Run a monitor
  • Run a performance test
  • Built-in reporters
  • Overview
  • Run a performance test
  • View performance test metrics
  • Overview
  • Test assertion failure trends
  • Test assertions by virtual user load
  • Debug performance test errors
  • View performance test run timeline
  • Inject data into virtual users
  • Troubleshoot performance tests
  • Overview
  • Set up a monitor
  • View monitor results
  • Overview
  • Publish monitor reports
  • Update monitor reports
  • Manage monitors
  • Overview
  • Configure a runner
  • Set up a runner in your network
  • Overview
  • Configure a runner to use a proxy server
  • Start a runner with the built-in proxy server
  • Manage a runner
  • Scale runners in your network
  • Troubleshoot
  • Run monitors using static IPs
  • Troubleshoot monitors
  • Monitoring FAQ
  • Overview
  • Set up a classic mock server
  • Make calls to mock servers
  • Create dynamic mock responses
  • Matching algorithm
  • Set up a code mock
  • Overview
  • Mock with response examples
  • Mock with the Postman API
  • Simulate real-world conditions
  • Overview
  • Collaboration concepts
  • Collaboration features
  • Work within teams
  • Manage access
  • Share your work
  • Collaborate with Live Sessions
  • Comment on APIs
  • Overview
  • Overview
  • Document a collection
  • Add API documentation
  • Write documentation
  • Publish documentation
  • View documentation
  • Host API documentation
  • Set up authentication for public APIs
  • Overview
  • Explore your Private API Network
  • Manage your Private API Network
  • Migrate your Private API Network
  • Overview
  • Fork Postman elements
  • Create pull requests
  • Review pull requests
  • Watch pull requests
  • Public elements
  • Overview
  • Create workspaces
  • Overview
  • Use workspaces
  • Manage workspaces
  • Share workspace updates
  • Overview
  • Set up a Partner Workspace
  • Collaborate as a partner
  • Multi-partner Workspaces
  • Manage Partner Workspaces
  • Team-to-team FAQ
  • Public workspaces
  • Workspace documents
  • Overview
  • Overview
  • Add types to parameters and headers
  • Add types to body data
  • View types and documentation
  • Generate API specifications
  • Overview
  • Create a specification
  • Import a specification
  • Edit a specification
  • Edit with the Visual editor
  • Add files to a specification
  • Validate a specification
  • View live documentation
  • Reuse components
  • Collaborate with specifications
  • Generate collections
  • Sync collections and specifications reference
  • Migrate from API Builder to Spec Hub
  • Develop APIs with the API Builder
  • Overview
  • Overview
  • Overview
  • Cloud connectors
  • Code discovery
  • Postman Insights
  • Cluster Watcher
  • Explore your services
  • Create and manage scorecards
  • Monitor security findings
  • Overview
  • Manage governance groups
  • Manage rulesets and functions
  • Overview
  • Overview
  • Try a local demo
  • Overview
  • Daemonset
  • Sidecar
  • AWS ECS
  • AWS EC2
  • AWS Elastic Beanstalk
  • Debug with Insights
  • Customize Insights
  • Overview
  • Memory errors
  • Traffic errors
  • Uninstall Insights Agent
  • Overview
  • Access
  • Redactions
  • Repro mode security
  • DaemonSet security
  • Overview
  • Overview
  • Overview tab
  • Errors tab
  • Latency tab
  • Endpoints tab
  • Diagnostics tab
  • Settings tab
  • Overview
  • API Catalog deployment modes
  • apidump
  • kube inject
  • kube helm-fragment
  • kube tf-fragment
  • ecs add
  • ecs task-def
  • ecs cf-fragment
  • completion
  • FAQ
  • Overview
  • Workspace reports
  • API lifecycle reports
  • Agent Mode report
  • Team and organization reports
  • API Governance report
  • Secret Scanner report
  • Overview
  • Overview
  • Overview
  • Overview
  • Search for public APIs
  • Browse public APIs
  • Consume public APIs
  • Overview
  • Overview
  • Become a verified publisher
  • Prepare your public workspace
  • Prepare your public collections
  • Overview
  • Curate your public collection's overview
  • Curate your public collection's requests
  • Curate your public collection's developer experience
  • Prepare your team workspace
  • Overview
  • Publish your public APIs
  • Overview
  • Create Run in Postman button
  • Customize Run in Postman button
  • Overview
  • Create MCP servers
  • Start MCP servers
  • Interact with MCP servers and AI models
  • Promote MCP servers
  • Maintain your public APIs
  • Explore your publisher tools
  • Analyze developer engagement
  • Overview
  • Overview
  • Generate SDKs from collections and API specifications
  • Generate SDKs locally and sync with GitHub
  • Overview
  • Use TypeScript SDKs
  • Use Java SDKs
  • Use Kotlin SDKs
  • Use Python SDKs
  • Use C# SDKs
  • Use Go SDKs
  • Use PHP SDKs
  • Use Ruby SDKs
  • Use Rust SDKs
  • Overview
  • Manual TypeScript
  • Auto TypeScript
  • Manual Java
  • Auto Java
  • Manual Kotlin
  • Auto Kotlin
  • Manual Python
  • Auto Python
  • Manual C#
  • Auto C#
  • Manual Go
  • Auto Go
  • Manual PHP
  • Auto PHP
  • Manual Ruby
  • Auto Ruby
  • Manual Rust
  • Auto Rust
  • Overview
  • Core options
  • Customization options
  • Language options
  • Troubleshoot SDKs
  • Overview
  • Generate an SDK with custom code
  • Automate SDK updates
  • Overview
  • Use generated CLIs
  • Use generated CLIs with AI agents
  • Overview
  • Document a collection
  • Overview
  • Onboarding checklist
  • Roles and permissions
  • System service accounts
  • Free and Solo experience
  • Team migration
  • Overview
  • Create an organization
  • Create teams
  • Manage user groups
  • Overview
  • Invite members
  • Manage roles
  • Manage your organization
  • Scale teams
  • Manage resources
  • Manage product access
  • Configure team settings
  • Manage API keys
  • Overview
  • How Secret Scanner works
  • Overview
  • Local Protection policies
  • Cloud Detection findings
  • Secret Scanner patterns
  • BYOK Encryption
  • Audit logs
  • Overview
  • Manage billing
  • Purchase Postman
  • About plans
  • About resource usage
  • About Postman AI usage
  • About Postman Flows usage
  • Overview
  • Webhooks
  • Installed apps
  • CI integrations
  • All integrations
  • APIMatic
  • Datadog
  • Overview
  • Overview
  • Connect a repository
  • Collaborate with your team
  • Back up your collection
  • GitLab
  • Overview
  • Connect your Jira account
  • Create a Jira issue
  • View your Jira issues
  • Overview
  • Get Teams notifications
  • Send monitoring results to Teams
  • New Relic
  • OpenAPI
  • PagerDuty
  • Overview
  • Postman app for Slack
  • Get Slack notifications
  • Personal notification types
  • Post monitoring results to Slack
  • Splunk
  • Splunk On-Call
  • Statuspage
  • Overview
  • Enterprise plans
  • Enterprise onboarding
  • Enterprise deployment
  • Account discovery and control
  • Organizations
  • Migrate to organizations
  • Set up a Postman Sandbox
  • Postman EU Data Residency
  • Overview
  • Overview
  • OpenAPI 3 rules
  • OpenAPI 2 rules
  • Overview
  • API Governance rules
  • Custom governance functions
  • Spectral
  • Intro to SSO
  • Configure SSO
  • Sign in to SSO
  • SSO and SCIM FAQs
  • Microsoft AD FS
  • Microsoft Entra ID
  • Custom SAML
  • Duo
  • Google Workspace
  • Okta
  • OneLogin
  • Ping Identity
  • Overview
  • Configure SCIM with Okta
  • Configure SCIM with Microsoft Entra ID
  • Configure SCIM with OneLogin
  • Overview
  • Add and verify a domain
  • Enable domain capture
  • Domain capture support and FAQs
  • Overview
  • Security for developers
  • Security for teams
  • Admin FAQs
  • Overview
  • Overview
  • Build your first flow
  • Manage Flows with Git
  • Overview
  • Create blocks
  • Connect blocks
  • Copy flows with clones
  • Loops overview
  • Loops with external data
  • Loops for pagination
  • Loops for polling
  • Work with date and time
  • Find and filter data
  • Run flows in the cloud
  • Send URL-encoded or form data to flows
  • Organize flows
  • Share and embed flows
  • Create a request
  • Version flows with snapshots
  • Configure values for flows
  • Assign input values
  • Visualize data
  • Check flow health and activity
  • Demo flows with slides
  • Connect third party services
  • Overview
  • Overview
  • Create your AI request blocks
  • Interact with AI models
  • Overview
  • MCP servers in Postman Flows
  • Create an MCP server flow
  • Troubleshoot flows
  • Overview
  • Blocks reference
  • Action blocks overview
  • API Request
  • Connector
  • HTTP Request
  • GraphQL Request
  • Flow
  • Trigger blocks overview
  • Output
  • Request
  • Response
  • Schedule
  • Start
  • MCP
  • AI blocks overview
  • AI Agent
  • AI Media
  • Create with AI
  • AI Request
  • Logic blocks overview
  • Condition
  • If
  • Validate
  • Evaluate
  • Delay
  • OR
  • Looping blocks overview
  • Repeat
  • For
  • Collect
  • Visualize blocks overview
  • Display
  • Log
  • Data blocks overview
  • String
  • Bool
  • Number
  • Null
  • Select
  • Now
  • Date
  • Date and time
  • List
  • Record
  • Create variable
  • Get variable
  • Template
  • Get configuration
  • Overview
  • Rename headers
  • Detect session cookie
  • Route response data
  • Overview
  • Get basic values
  • Select conditional data
  • Return structured data
  • Manipulate data
  • Function reference
  • Deployed flows overview
  • Connector blocks overview
  • Overview
  • Use TypeScript in an Evaluate block
  • Iterate through a list using a For loop
  • Select data from complex JSON
  • Persist data outside a flow
  • Use the AI Agent block as logic for a flow
  • Overview
  • Overview
  • Send a request
  • Calculate years since milestone
  • Create a count-based loop
  • Create a list-based loop
  • Overview
  • Exchange data between systems
  • Create a dashboard in Flows
  • Automate repetitive tasks
  • Run requests in sequence
  • Overview
  • Overview
  • Install
  • Postman CLI GitHub Action
  • Overview
  • Basic CLI commands
  • API governance commands
  • Application commands
  • Authentication commands
  • Coding agent commands
  • Collection commands
  • Dataset commands
  • Flows commands
  • Mock server commands
  • Monitoring and performance commands
  • Publish API versions commands
  • Request commands
  • SDK Generator commands
  • Search commands
  • Simulator commands
  • Webhook commands
  • Workspace commands
  • Overview
  • Install
  • View and analyze results
  • Lens commands
  • Overview
  • Postman Echo service
  • Postman Collection SDK
  • Postman Runtime library
  • Postman code generator
  • API format conversion
  • Postman API overview
  • Postman API authentication
  • Postman API access rate limits
  • Make a call with the Postman API
  • Overview
  • Remote server setup
  • Local server setup
  • Tips and best practices
  • Overview
  • Install and sign in
  • Overview
  • Import Postman data
  • Import environment variables
  • Send requests
  • Add and manage certificates
  • Create and manage collections
  • Create and manage environments
  • Share your work and manage access
  • Document APIs
  • Overview
  • Write scripts
  • Use packages in scripts
  • Run collections
  • Manage Postman with AI agents
  • Feedback
  • Run and test collections with Newman CLI
  • Install and run Newman
  • Newman command reference
  • Upload files with Newman
  • Use Newman built-in reporters
  • Use Newman external and custom reporters
  • Newman with Docker
  • CI with Newman
  • Travis CI with Newman
  • Jenkins with Newman
  • Migrate to the Postman CLI
Use PostmanAgent Mode

Use Postman AI Recipes

||View as Markdown|
Something went wrong!
Was this page helpful?
Previous

Agent Mode Enterprise features

Next

Troubleshoot Agent Mode

Built with
Postman API Platform

Product

  • Postman Overview
  • Enterprise
  • Spec Hub
  • Flows
  • Agent Mode
  • API Catalog
  • Fern
  • Postman CLI
  • Integrations
  • Workspaces
  • Plans and Pricing

API Network

  • App Security
  • Artificial Intelligence
  • Communication
  • Data Analytics
  • Database
  • Developer Productivity
  • DevOps
  • E-Commerce
  • eSignature
  • Financial Services
  • Payments
  • Travel

Resources

  • Postman Docs
  • Academy
  • Community
  • Templates
  • Intergalactic
  • Videos
  • MCP Servers

Legal and Security

  • Legal Terms Hub
  • Terms of Service
  • Postman Product Terms
  • Security
  • Website Terms of Use

Company

  • About
  • Careers and Culture
  • Contact Us
  • Partner Program
  • Customer Stories
  • Press and Media
  • Events
X iconLinkedIn iconGithub iconYouTube iconInstagram iconDiscord icon
Download Postman
| Tracking Cookies Used.
Privacy Policy

© 2026 Postman, Inc.