Skip to main content

Introduction

The Postman toolkit integrates ELITEA with your Postman workspace, enabling Agents, Pipelines, and Chat conversations to automate API collection management, execute requests, and streamline API testing workflows — all directly from within ELITEA.

Brief Overview of Postman

Postman is a leading web-based API platform that helps teams of all sizes efficiently design, test, document, and manage APIs.

API Request Management

Create, organize, and manage API requests and collections with rich documentation and environment variables.

Automated Testing

Define and execute automated API tests, track results in real-time, and integrate with CI/CD pipelines.

Collection Organization

Structure API requests into logical collections and folders for improved maintainability and discoverability.

Integration with Development Tools

Seamlessly integrates with version control, CI/CD, and other tools, making it a central hub for your API ecosystem.

Collaboration & Sharing

Share collections, environments, and test results with your team for better collaboration.
Integrating Postman with ELITEA brings these robust API management capabilities directly into your AI-driven workflows. Your ELITEA Agents, Pipelines, and Chat conversations can intelligently interact with your Postman workspace to automate API-related tasks, manage collections and requests, and improve team collaboration.

Toolkit’s Account Setup and Configuration

Account Setup If you don’t already have a Postman account, follow these steps to create one:
  1. Visit Postman: Navigate to postman.com
  2. Sign Up: Click the “Sign Up” button
  3. Enter Details: Provide your email address, enter your name, and create a secure password
  4. Verify Email: Check your inbox for a verification email from Postman and click the verification link to activate your account
  5. Log In: Once verified, log in to Postman with your credentials

Generate an API Key

For secure integration with ELITEA, you must use a Postman API Key. This method is significantly more secure than using your primary Postman account password directly. Follow these steps to generate an API Key in Postman:
  1. Log in to Postman: Access your Postman account at postman.com.
  2. Navigate to API Keys:
    • In the Postman app: Click your profile icon in the top-right corner → “Settings”“API Keys” tab.
    • In the browser: Click the settings icon“Account Settings”“API Keys” tab.
    Navigate
  3. Create API Key: Click the “Generate API Key” button and provide a descriptive name (e.g., “ELITEA Integration Key”).
  4. Copy and Store the API Key: Immediately copy the generated API key — this is the only time it will be displayed in full. Store it securely in a password manager or ELITEA’s Secrets feature. Postman-Access_API_Keys
Principle of Least Privilege: The Postman API Key grants access to your Postman workspace using your account’s permissions. Store keys securely and rotate them periodically.Use ELITEA Secrets: Always reference your API key through ELITEA’s Secrets feature rather than entering it directly in configuration fields.

Find Your Collection ID and Workspace ID

To configure the Postman toolkit in ELITEA, you will need the Collection ID and Workspace ID. Here’s how to find them in the Postman web interface:

How to Find the Workspace ID

Option 1: From the Postman App
  1. Open Postman and navigate to the workspace you want to use.
  2. Open Workspace info: Click the ellipsis (...) icon next to the workspace name, then select “Workspace Info”.
  3. Copy the Workspace ID: The Workspace ID (UUID) is displayed in the modal window. Copy it directly. Postman-Workspace_Id
Option 2: From the Browser URL
  1. Open Postman in the browser and select the workspace you want to use.
  2. Locate the Workspace ID in the URL:
    • The URL follows the pattern: https://<team>.postman.co/workspace/<workspace-name>~<workspace-id>/overview
    • The UUID value after the ~ symbol is your Workspace ID.
The workspace URL contains both the workspace name and its UUID separated by ~. Copy only the UUID part that comes after the ~ symbol — do not include the workspace name or the ~ itself.Example:
  • URL: https://myteam.postman.co/workspace/MyWorkspace~12345678-abcd-efgh-ijkl-1234567890ab/overview
  • Workspace ID: 12345678-abcd-efgh-ijkl-1234567890ab

How to Find the Collection ID

  1. Open Postman and navigate to the workspace containing your collection.
  2. Select the Collection you want to use.
  3. Locate the Collection ID:
    • In the browser URL, you will see a path like https://web.postman.co/workspace/<workspace-name>/collection/<collection-id>.
    • The UUID value after /collection/ is your Collection ID.
  • URL: https://web.postman.co/workspace/MyWorkspace/collection/12345678-90ab-cdef-1234-567890abcdef
  • Collection ID: 12345678-90ab-cdef-1234-567890abcdef Postman-Colection_Id
You can also use the Postman API to programmatically list collections and workspaces, which will include their IDs in the response.

System Integration with ELITEA

To integrate Postman with ELITEA, you need to follow a three-step process: Create Credentials → Create Toolkit → Use in Agents. This workflow ensures secure authentication and proper configuration.

Step 1: Create Postman Credentials

Before creating a toolkit, you must first create Postman credentials in ELITEA:
  1. Navigate to Credentials Menu: Open the sidebar and select Credentials.
  2. Create New Credential: Click the + Create button.
  3. Select Postman: Choose Postman as the credential type.
  4. Configure Credential Details:
  5. Save Credential: Click Save to create the credential Create Credential
It’s highly recommended to use Secrets for API Keys instead of entering them directly. Create a secret first, then reference it in your credential configuration.

Step 2: Create Postman Toolkit

Once your credentials are configured, create the Postman toolkit:
  1. Navigate to Toolkits Menu: Open the sidebar and select Toolkits.
  2. Create New Toolkit: Click the + Create button.
  3. Select Postman: Choose Postman from the list of available toolkit types.
  4. Configure Toolkit Settings:
  5. Enable Desired Tools: In the “Tools” section, select the checkboxes next to the specific Postman tools you want to enable. Enable only the tools your agents will actually use to follow the principle of least privilege.
    • Make Tools Available by MCP — (optional checkbox) Enable this option to make the selected tools accessible through external MCP clients.
  6. Save Toolkit: Click Save to create the toolkit Create Toolkit
The Collection ID is required and scopes the toolkit to a single Postman collection. All folder, request, and analysis operations work within this collection. To work with multiple collections, create separate toolkit instances with different Collection IDs.

Environment Config Format

The Environment Config field accepts a JSON object that provides variable values used when executing requests. The variable names should match the environment variables defined in your Postman environment (e.g., exported from Environments in Postman). There are two supported formats: Simple key-value variables (used to resolve {{variable}} placeholders in requests):
The keys in this JSON should match the variable names in your Postman environment. For example, if your Postman environment defines base_url, project_id, and auth_token, use those exact names here. The toolkit will substitute {{base_url}}, {{project_id}}, and {{auth_token}} placeholders in your requests with the values provided.
Structured authentication (used to inject auth headers directly when executing requests):
Supported auth.type values: bearer, basic, api_key, oauth2, custom.
The Environment Config field does not accept the raw JSON file exported from Postman (which contains id, name, values array, and metadata). You must manually extract the variable names and their values and build a flat key-value JSON object.Exported Postman environment (not supported):
Environment Config to paste in ELITEA (supported):

Available Tools

The Postman toolkit provides the following tools for interacting with Postman collections, folders, and requests, organized by functional category:
The Delete collection, Delete folder, and Delete request tools permanently remove data from your Postman workspace. Enable only these tools if your agent genuinely requires deletion capabilities, and always follow the principle of least privilege.

Testing Toolkit Tools

After configuring your Postman toolkit, you can test individual tools directly from the Toolkit detail page using the Test Settings panel. This lets you verify credentials and validate tool behavior before deploying to your workflows. General Testing Steps:
  1. Select LLM Model: Choose a Large Language Model from the model dropdown in the Test Settings panel
  2. Configure Model Settings: Adjust model parameters as needed
  3. Select a Tool: Choose the specific Postman tool you want to test
  4. Provide Input: Enter any required parameters for the selected tool
  5. Run the Test: Execute the tool and wait for the response
  6. Review the Response: Confirm the tool returns expected results
  • Verify that Postman credentials and connection are configured correctly
  • Validate that tools function as expected with your Postman collection
  • Test different parameter combinations before production use
  • Familiarize yourself with tool capabilities and expected outputs
For detailed instructions on how to use the Test Settings panel, see How to Test Toolkit Tools.

Step 3: Add Postman Toolkit to Your Workflows

Now you can add the configured Postman toolkit to your agents, pipelines, or use it directly in chat:
  1. Navigate to Agents: Open the sidebar and select Agents
  2. Create or Edit Agent: Either create a new agent or select an existing agent to edit
  3. Add Postman Toolkit:
    • In the “TOOLKITS” section of the agent configuration, click the “+Toolkit” icon
    • Select your desired Postman toolkit from the dropdown menu
    • The toolkit will be added to your agent with the previously configured tools enabled
    Agent

Instructions and Prompts for Using the Postman Toolkit

To effectively instruct your ELITEA Agent to use the Postman toolkit, provide clear and precise instructions within the Agent’s “Instructions” field. These instructions guide the Agent on when and how to utilize the available Postman tools.

Instruction Creation for Agents

When crafting instructions for the Postman toolkit, clarity and precision are paramount. Break down complex tasks into a sequence of simple, actionable steps and explicitly define all parameters required for each tool. Agents respond best to instructions that are:
  • Direct and Action-Oriented: Use strong action verbs and clear commands, for example: “Use the get_collections tool…”, “Execute the request using execute_request…”, “Analyze the collection using analyze…”.
  • Parameter-Centric: Enumerate each required parameter by name and specify how the Agent should determine its value — from user input, from a previous step, from a hardcoded value, or from a variable.
  • Contextually Rich: Provide sufficient background so the Agent understands the overarching objective and which tool to apply within each step of the workflow.
  • Step-by-Step Structure: Organize instructions into numbered steps for complex multi-tool workflows.
  • Add Conversation Starters: Include example conversation starters that users can use to trigger the functionality.
When instructing your Agent to use a Postman toolkit tool, follow this structured pattern:
  1. State the Goal: Clearly state the objective. For example, “Goal: Execute a specific API request and display the response.”
  2. Specify the Tool: Indicate the tool to use. For example, “Tool: Use the execute_request tool.”
  3. Define Parameters: List all required parameters, including how the Agent should obtain each value.
  4. Describe Expected Outcome (Optional): Briefly describe what should happen after tool execution.
  5. Add Conversation Starters: Include example prompts that users can try.
Agent Instructions for Executing an API Request:
Agent Instructions for Analyzing a Collection:

Chat Usage Examples by Tool Category

The following examples demonstrate how to interact with the Postman toolkit in ELITEA Chat, organized by functional category.
Chat Example:
Chat Example:
Chat Example:
Chat Example:
Chat Example:
Chat Example:
Chat Example:
Chat Example:
Chat Example:

Troubleshooting

Problem: Agent fails to connect to Postman or experiences timeout errorsPossible Error Messages:
  • “Postman API request failed: connection refused”
  • “Postman API request failed: connection timed out”
  • “Invalid JSON response from Postman API”
Solutions:
  1. Verify Base URL Format:
    • Use https://api.getpostman.com (without a trailing slash)
    • Ensure the URL starts with https://
  2. Check Network Connectivity:
    • Verify you can access https://api.getpostman.com from your environment
    • Check firewall or proxy settings that may block outbound API calls
  3. API Endpoint Validation:
    • Errors surface when the first API call is made (e.g., when a tool is first invoked after saving the toolkit)
    • Verify your API key and workspace settings are correctly configured if an initial tool call returns an error
Problem: “Unauthorized”, “Forbidden”, or API key-related errorsPossible Error Messages:
  • “401 Unauthorized”
  • “403 Forbidden”
  • “Authentication failed”
Solutions:
  1. Verify API Key:
    • Ensure the API key is copied correctly without leading or trailing spaces
    • Confirm the API key has not been revoked or expired in Postman Settings → API Keys
  2. Regenerate if Necessary:
    • If the key is compromised or invalid, generate a new one in Postman Settings
    • Update the toolkit credential with the new key and delete the old key for security
Problem: Cannot find specified collection, folder, or requestPossible Error Messages:
  • "Postman API request failed: 404 Client Error" (invalid Collection or Workspace ID)
  • "Folder '{folder_path}' not found in collection '{collection_id}'" (incorrect folder path)
  • "Request '{request_path}' not found" (incorrect request path)
  • "Parent folder '{parent_path}' not found" (invalid parent path in create_folder)
  • "Source folder '{source_path}' not found" / "Source request '{source_path}' not found" (move or duplicate operations)
Solutions:
  1. Verify Collection ID:
    • Confirm the Collection ID in the toolkit settings matches the UUID visible in the Postman URL
    • Collection IDs are case-sensitive UUIDs (e.g., 12345678-90ab-cdef-1234-567890abcdef)
  2. Verify Workspace ID:
    • Confirm the Workspace ID in the credential matches the UUID in the Postman URL
    • Verify the collection belongs to the specified workspace
  3. Path-Based Resources:
    • Folder and request paths are case-sensitive and must exactly match the names in Postman
    • Use the get_collection tool to inspect the actual names before using path-based tools
    • Nested paths use / as separator: ParentFolder/ChildFolder/RequestName
Problem: The execute_request tool fails or returns unexpected resultsPossible Error Messages:
  • “Request not found at path”
  • HTTP error responses from the target API
Solutions:
  1. Verify Request Path:
    • Use get_request_by_path or search_requests to confirm the correct path before executing
    • Paths are case-sensitive
  2. Check Variable Resolution:
    • If the request uses {{variable}} placeholders, ensure the Environment Config JSON contains matching keys
    • Use override_variables for per-call overrides: '{"base_url": "https://api.example.com"}'
    • If override_variables contains invalid JSON it is silently ignored — execution continues with no overrides applied. If variable substitution is not working, check the JSON syntax of the override_variables argument.
  3. Authentication Configuration:
    • Ensure the auth block in Environment Config is correctly structured for your authentication type
    • Supported types: bearer, basic, api_key, oauth2, custom
    • Example for bearer auth: {"auth": {"type": "bearer", "bearer": [{"value": "your-token"}]}}
  4. Target API Availability:
    • Verify the target API endpoint is accessible from the ELITEA environment
    • Check that all required variable values are provided in Environment Config

Support Contact

If you encounter issues not covered in this guide or need additional assistance, please refer to Contact Support for detailed information on how to reach the ELITEA Support Team.

FAQ

No, you must use a Postman API Key for integration. Regular passwords are not supported. API Keys are more secure, can be individually revoked without changing your account password, and are the recommended authentication method for API integrations.Generate your API Key at: Postman Settings → API Keys.
  • Collection ID: Visible in the Postman web URL when viewing a collection: .../collection/<collection-id>
  • Workspace ID: Visible in the Postman web URL when viewing a workspace: .../workspace/<workspace-id>
  • Request paths: Use the get_collection tool to list all paths in the collection in flattened format, then use those paths with path-based tools (e.g., Auth/Login)
  • Request IDs: Use search_requests or get_request_by_path to discover request IDs programmatically
Each toolkit instance is scoped to a single collection via the Collection ID setting. To work with multiple collections, create separate toolkit instances — each can reference the same credential but point to a different collection.Example Setup:
Yes. The execute_request tool resolves authentication at execution time using:
  1. Environment Config variables — Simple key-value pairs that replace {{variable}} placeholders in the request
  2. Environment Config auth object — A structured auth block that injects authentication headers into the outbound HTTP call
  3. Override variables — Per-call overrides passed as a JSON string to the override_variables parameter
Example Environment Config with bearer authentication:
Other supported auth types use a params key:
Postman uses collaborative, last-write-wins editing. Changes made through the ELITEA toolkit are synchronized to the Postman workspace immediately. Be aware that concurrent modifications may overwrite each other. For critical collections, coordinate changes with your team or use Postman’s fork and pull request features.
Yes, as long as the API key used in the credential has access to the collection’s workspace. The analyze tool works on any collection accessible to the API key. Verify your workspace membership and collection visibility settings in Postman if access issues arise.
The Available Tools table reflects only the tools that are currently active in the SDK implementation. Some capabilities (such as create_collection and update_collection_name) are not yet exposed as toolkit tools. The list will expand as the toolkit evolves.