> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman Integration for AI Agents & Workflows

> API development and testing platform for building, monitoring, and managing APIs

{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}

<img src="https://mintcdn.com/modulexaillc/df8MOr-hXotYLTh5/logos/postman.svg?fit=max&auto=format&n=df8MOr-hXotYLTh5&q=85&s=e906e090022b8d10355dae01a0357c6c" alt="Postman logo" width="72" height="72" data-path="logos/postman.svg" />

## Overview

Add **Postman** to any ModuleX agent or workflow. API development and testing platform for building, monitoring, and managing APIs against the Postman REST API (`api.getpostman.com`).

<Info>
  **Categories**: Developer Tools & Infrastructure · Api Testing · **Auth**: API Key · **Actions**: 4
</Info>

## Authentication

### API Key Authentication

Authenticate using your Postman API key

<Steps>
  <Step title="Step 1">
    Go to [https://web.postman.co](https://web.postman.co) and sign in
  </Step>

  <Step title="Step 2">
    Click your avatar in the top-right, then select Settings
  </Step>

  <Step title="Step 3">
    Navigate to the 'API Keys' tab
  </Step>

  <Step title="Step 4">
    Generate a new API key or copy your existing one
  </Step>

  <Step title="Step 5">
    Paste the API key below
  </Step>
</Steps>

#### Required Credentials

| Field           | Description                                                   | Required | Format                                                           |
| --------------- | ------------------------------------------------------------- | -------- | ---------------------------------------------------------------- |
| Postman API Key | Your Postman API key from web.postman.co/settings/me/api-keys | Yes      | `PMAK-xxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |

## Available Actions

<AccordionGroup>
  <Accordion title="create_environment — Create a new environment in Postman with optional variables">
    ### Parameters

    <ResponseField name="environment_name" type="string" required>
      The name for the new environment
    </ResponseField>

    <ResponseField name="workspace_id" type="string">
      The ID of the workspace to create the environment in
    </ResponseField>

    <ResponseField name="variables" type="array">
      List of variable objects with keys: key (string), value (string), enabled (boolean), type ('secret' or 'default')
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "environment_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Environment Id"
        },
        "environment_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Environment Name"
        }
      },
      "required": [
        "success"
      ],
      "title": "CreateEnvironmentOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="list_workspace_id_options — List available workspaces with their IDs and names">
    ### Response

    ```json theme={null}
    {
      "$defs": {
        "WorkspaceSummary": {
          "additionalProperties": false,
          "properties": {
            "id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Id"
            },
            "name": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Name"
            },
            "type": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "default": null,
              "title": "Type"
            }
          },
          "title": "WorkspaceSummary",
          "type": "object"
        }
      },
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "workspaces": {
          "items": {
            "$ref": "#/$defs/WorkspaceSummary"
          },
          "title": "Workspaces",
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "title": "ListWorkspaceIdOptionsOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="run_monitor — Run a specific monitor in Postman">
    ### Parameters

    <ResponseField name="monitor_id" type="string" required>
      The ID of the monitor to run
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "run": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Run"
        }
      },
      "required": [
        "success"
      ],
      "title": "RunMonitorOutput",
      "type": "object"
    }
    ```
  </Accordion>

  <Accordion title="update_variable — Update a specific environment variable in Postman">
    ### Parameters

    <ResponseField name="environment_id" type="string" required>
      The ID of the environment containing the variable
    </ResponseField>

    <ResponseField name="variable" type="string" required>
      The variable key (name) to update
    </ResponseField>

    <ResponseField name="variable_value" type="string" required>
      The new value for the variable
    </ResponseField>

    <ResponseField name="workspace_id" type="string">
      The ID of the workspace containing the environment
    </ResponseField>

    <ResponseField name="variable_enabled" type="boolean">
      Whether the variable is enabled or not
    </ResponseField>

    ### Response

    ```json theme={null}
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "title": "Success",
          "type": "boolean"
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Error"
        },
        "environment_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Environment Id"
        },
        "environment_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Environment Name"
        }
      },
      "required": [
        "success"
      ],
      "title": "UpdateVariableOutput",
      "type": "object"
    }
    ```
  </Accordion>
</AccordionGroup>

## Limits & Quotas

* **Free plan**: 25 requests/minute per API key.
* **Paid plans**: Higher limits; see
  [https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).
* **Error model**: non-2xx responses and timeouts are caught and returned as
  `success=False` + `error` rather than raising. Plan for retries on the agent
  side based on the error string.

## Related integrations

<CardGroup cols={3}>
  <Card title="Algolia" href="/integrations/tools/algolia" />

  <Card title="Amazon Web Services" href="/integrations/tools/aws" />

  <Card title="Apify" href="/integrations/tools/apify" />
</CardGroup>

## Links

* [Postman](https://www.postman.com)