Introduction
Purpose of this Guide
This guide is your definitive resource for integrating and utilizing the Postman toolkit within ELITEA. It provides a step-by-step walkthrough, from setting up your Postman API Key to configuring the toolkit in ELITEA and effectively using it within your Agents. By following this guide, you will unlock the power of automated API testing, streamlined workflows, and enhanced team collaboration, all directly within the ELITEA platform. This integration empowers you to leverage AI-driven automation to optimize your API testing lifecycle using the combined strengths of ELITEA and Postman.Brief Overview of Postman
Postman is a popular, web-based API platform that helps teams of all sizes efficiently design, test, and manage APIs. It provides a centralized platform to streamline your API development and testing process, offering features for:- API Request Management: Create, organize, and manage API requests and collections with rich documentation and environment variables.
- Automated Testing: Plan and execute automated API tests, track results in real-time, and integrate with CI/CD pipelines.
- Reporting & Metrics: Generate insightful reports and metrics on API test coverage, results, and performance.
- 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.
Postman Account Setup and Configuration
Account Setup
If you don’t have a Postman account yet, here’s how to get started:- Go to Postman Website: Open your web browser and navigate to Postman’s official website.
- Sign Up: Click the “Sign Up” button and provide your details. You can sign up with an email address or use a Google account.
- Verify Your Email: Open the confirmation email from Postman and click on the verification link provided within the email.
- Access Your Account: After email verification, you will be redirected to your new Postman workspace. Follow any on-screen instructions to complete the setup.
API Key Generation in Postman
To securely integrate Postman with ELITEA, you need to generate an API key within Postman. This API key will be used by ELITEA to authenticate and access your Postman workspace. Follow these steps to create an API Key:- Log in to Postman: Access your Postman account using your credentials.
- Access API Keys: Click on your profile icon in the top right corner, then select “Settings”. Navigate to the “API Keys” tab.
- Create API Key: Click the “Create API Key” button, provide a name for the key (e.g., “ELITEA Integration Key”), and set the desired scopes/permissions.
-
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 using a password manager or ELITEA’s built-in Secrets feature (recommended for enhanced security within ELITEA). You will need this API Key to configure the Postman toolkit in ELITEA.


Get Collection Id and Workspace Id in Postman
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 Collection Id
- Open Postman and navigate to the workspace containing your collection.
- Select the Collection you want to use.
- 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 value after
/collection/is your Collection Id. - Alternatively, you can use the Postman API to list collections and retrieve their IDs.
- In the browser URL, you will see a path like
- Example:
- URL:
https://web.postman.co/workspace/MyWorkspace/collection/12345678-90ab-cdef-1234-567890abcdef - Collection Id:
12345678-90ab-cdef-1234-567890abcdef
- URL:
How to Find the Workspace Id
- Open Postman and go to the workspace you want to use.
- Locate the Workspace Id:
- In the browser URL, you will see a path like
https://web.postman.co/workspace/<workspace-id>. - The value after
/workspace/is your Workspace Id. - Alternatively, you can use the Postman API to list workspaces and retrieve their IDs.
- In the browser URL, you will see a path like
- Example:
- URL:
https://web.postman.co/workspace/abcdef12-3456-7890-abcd-ef1234567890 - Workspace Id:
abcdef12-3456-7890-abcd-ef1234567890
- URL:
Tip: 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:- Navigate to Credentials Menu: Open the sidebar and select Credentials.
- Create New Credential: Click the
+ Createbutton. - Select Postman: Choose Postman as the credential type.
- Configure Credential Details:
- Display Name: Enter a descriptive name (e.g., “Postman - API Testing”)
- Base URL: Enter the Postman API base URL (typically
https://api.getpostman.com/) - Workspace ID: Enter your Postman workspace ID (found in the workspace URL)
- API Key: Enter your Postman API key (the one you generated in the previous section)
- Save Credential: Click Save to create the credential

Step 2: Create Postman Toolkit
Once your credentials are configured, create the Postman toolkit:- Navigate to Toolkits Menu: Open the sidebar and select Toolkits.
- Create New Toolkit: Click the
+ Createbutton. - Select Postman: Choose Postman from the list of available toolkit types.
- Configure Toolkit Details:
- Name: Enter a descriptive name for your toolkit (e.g., “Postman - API Collection Manager”)
- Description: Enter a brief description of the toolkit’s purpose (e.g., “Manages Postman API collections and automates API testing workflows”)
- Configure Credentials:
- In the Configuration section, select your previously created Postman credential from the Credentials dropdown
- Configure Collection Settings (Optional):
- Collection ID: Enter a default collection ID to scope toolkit operations
- Environment Config: Enter JSON configuration for request execution (auth headers, project IDs, base URLs, etc.)
- 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
- Save Toolkit: Click Save to create the toolkit

Available Tools:
The Postman toolkit provides the following tools for interacting with Postman collections, folders, and requests, organized by functional categories:| Tool Category | Tool Name | Description | Primary Use Case |
|---|---|---|---|
| Collection Access | |||
| Get collections | Retrieves all collections accessible in the workspace | List and browse available API collections | |
| Get collection | Retrieves a specific collection in flattened format with path-based structure | Access collection structure and details | |
| Duplicate collection | Creates a copy of an existing collection | Create backups or variants of collections for testing | |
| Folder Management | |||
| Get folder | Retrieves a specific folder in flattened format with path-based structure | Access folder structure and contents | |
| Create folder | Creates a new folder within a collection | Organize requests into logical groups | |
| Update folder | Updates folder properties (name, description, auth) | Modify folder metadata and settings | |
| Move folder | Moves a folder to a different location within the collection | Reorganize collection structure | |
| Request Access | |||
| Get request by path | Retrieves a specific request by its path | Access requests using hierarchical paths | |
| Get request by ID | Retrieves a specific request by its unique ID | Direct access to specific requests | |
| Get request script | Retrieves the test or pre-request script content | Review automation scripts in requests | |
| Search requests | Searches for requests across the collection | Find requests by name or criteria | |
| Request Management | |||
| Create request | Creates a new API request in a folder | Add new API endpoints to collections | |
| Update request name | Updates the name of a request | Rename requests for clarity | |
| Update request method | Updates the HTTP method (GET, POST, etc.) | Change request type | |
| Update request URL | Updates the request URL | Modify endpoint addresses | |
| Update request description | Updates the request description | Add or update documentation | |
| Update request headers | Updates request headers | Modify authentication and content headers | |
| Update request body | Updates the request body (payload) | Change request data | |
| Update request auth | Updates request authentication settings | Configure request-level auth | |
| Update request tests | Updates the test scripts for a request | Add or modify test automation | |
| Update request pre script | Updates the pre-request script | Add or modify pre-request setup | |
| Duplicate request | Creates a copy of an existing request | Create request variants or templates | |
| Move request | Moves a request to a different folder | Reorganize requests within collections | |
| Collection Management | |||
| Update collection description | Updates the description of a collection | Add or update collection documentation | |
| Update collection variables | Updates the variables defined at the collection level | Manage collection-wide variables | |
| Update collection auth | Updates the authentication settings for a collection | Configure collection-level auth | |
| Execution & Analysis | |||
| Execute request | Executes a Postman request with environment variables | Run API tests and validate responses | |
| Analyze | Analyzes collection, folder, or request for API quality and best practices | Identify issues and improvement opportunities |
Step 3: Use Postman Toolkit in Agents
Once your Postman toolkit is created, you can use it in various ELITEA features:In Agents:
- Navigate to Agents: Open the sidebar and select Agents.
- Create or Edit Agent: Click
+ Createfor a new agent or select an existing agent to edit. - Add Postman Toolkit:
- In the “Tools” section of the agent configuration, click the “+Toolkit” icon
- Select your Postman toolkit from the dropdown menu
- The toolkit will be added to your agent with the previously configured tools enabled

In Pipelines:
- Navigate to Pipelines: Open the sidebar and select Pipelines.
- Create or Edit Pipeline: Either create a new pipeline or select an existing pipeline to edit.
- Add Postman Toolkit:
- In the “Tools” section of the pipeline configuration, click the “+Toolkit” icon
- Select your Postman toolkit from the dropdown menu
- The toolkit will be added to your pipeline with the previously configured tools enabled

In Chat:
- Navigate to Chat: Open the sidebar and select Chat.
- Start New Conversation: Click +Create or open an existing conversation.
- Add Toolkit to Conversation:
- In the chat Participants section, look for the Toolkits element
- Click to add a toolkit and select your Postman toolkit from the available options
- The toolkit will be added to your conversation with all previously configured tools enabled
- Use Toolkit in Chat: You can now directly interact with your Postman collections by asking questions or requesting actions that will trigger the Postman toolkit tools.

Instructions and Prompts for Using the Toolkit
To instruct your ELITEA Agent to use the Postman toolkit, you need to provide clear instructions within the Agent’s “Instructions” field. These instructions guide the Agent on when and how to use the available tools.Instruction Creation for OpenAI Agents
When creating instructions for the Postman toolkit for OpenAI-based Agents, focus on clear, action-oriented language. Break down tasks into simple steps and explicitly state the parameters required for each tool. OpenAI Agents respond best to instructions that are:- Direct and Imperative: Use action verbs and clear commands (e.g., “Use the ‘get_collections’ tool…”, “Update the request body using ‘update_request_body’…”).
- Parameter-Focused: Clearly list each parameter and how the Agent should determine its value.
- Context-Aware: Provide enough context so the Agent understands the overall goal and when to use specific tools within a workflow.
- Define the Goal: Clearly state the objective or what the agent needs to accomplish. For example, “Goal: Execute a specific API request and validate the response.”
- Specify the Tool: Clearly indicate the specific Postman tool to be used for this step. For example, “Tool: Use the ‘execute_request’ tool.”
-
Define Parameters: Provide a detailed list of all parameters required by the selected tool. For each parameter:
- Parameter Name:
<Parameter Name as defined in tool documentation> - Value or Source:
<Specify the value or how to obtain the value. Examples: "user input", "from previous step", "hardcoded value 'req123'", "value of variable X">
- Parameter Name:
- Describe Expected Outcome (Optional but Recommended): Briefly describe the expected result or outcome after the tool is successfully executed. For example, “Outcome: The Agent will execute the request and display the API response with status code and body.”
- Add Conversation Starters: Include example conversation starters that users can use to trigger this functionality. For example, “Conversation Starters: ‘Execute request req123’, ‘List all collections’, ‘Analyze collection for best practices‘“
Example Agent Instructions
Agent Instructions for Executing an API Request:Chat Usage Examples by Tool Category
The following examples demonstrate how to interact with the Postman toolkit in ELITEA Chat, organized by functional categories. Each example shows the user request and the expected agent behavior.Collection Access - Get Collections
Chat Example:Request Access - Search Requests
Chat Example:Execution & Analysis - Execute Request
Chat Example:- Content-Type: application/json
- Authorization: Bearer [token]
- Total Requests: 12
- Issues Found: 5
- Warnings: 3
- Best Practices Score: 75%
-
Missing Documentation (3 requests)
- Requests without descriptions: POST /api/users/update, DELETE /api/users/:id, GET /api/users/search
- Recommendation: Add clear descriptions explaining the purpose and usage of each endpoint
-
Inconsistent Error Handling (2 requests)
- Missing error response examples for POST /api/auth/login, POST /api/auth/refresh
- Recommendation: Document expected error responses and status codes
-
Incomplete Test Scripts (4 requests)
- No automated tests found for POST /api/users/create, PUT /api/users/:id, etc.
- Recommendation: Add test scripts to validate response structure and status codes
- Some requests use hardcoded values instead of environment variables
- Authentication headers not consistently applied across all requests
- Missing pre-request scripts for token refresh logic
- Use environment variables for base URLs and API keys
- Implement consistent authentication patterns across all requests
- Add comprehensive test coverage for critical endpoints
- Request ID: req_new_001
- Method: GET
- URL: /api/users/profile
- Folder: fld_users
- Description: Retrieve authenticated user profile information
- Headers:
- Authorization: Bearer
- Content-Type: application/json
- Query Parameters: None
- Body: None
- Request ID: req_auth_001
- Method: POST /api/auth/login
- Updated Field: Request Body
- Added
validate_emailfield set to true - Added
remember_mefield for session persistence
- Folder ID: fld_auth_001
- Name: Authentication
- Collection: User API (col_123)
- Description: Authentication and authorization endpoints