Starting a profile with Postman

The Start Browser Profile endpoint enables you to launch existing regular browser profiles programmatically, making it a cornerstone for automation workflows. This guide walks you through using the endpoint (version 2) in Postman, covering prerequisites, configuration, and execution.

What's New in Version 2?

Version 2 of the Start Browser Profile endpoint introduces enhanced response accuracy, ensuring more reliable automation outcomes compared to its predecessor.

Prerequisites

Before diving in, complete the following steps to ensure a smooth setup:

1. Configure Postman Authentication Complete the three steps outlined in How to Set Up Indigo X API with Postman, including the "Configure the Bearer Token for Requests" section, to ensure proper sign-in.

2. Set Up Your Postman Workspace Ensure you have access to the Launcher folder in your Postman workspace. Locate the GET Start Browser Profile request within this folder.

3. Gather Required IDs Obtain the folder_id and profile_id for the browser profile you want to launch. Use the following resources to find these values:

   • DevTools Guide
   • Postman Guide

Agent Connection

Ensure the agent is connected before proceeding. The agent is critical for enabling profile launching.

Configuring the Request

To configure the GET Start Browser Profile request in Postman, update the script with the necessary parameters. Below are the variables you need to set:

Variable	Description	Required?
folder_id	The ID of the folder containing the browser profile.	Yes
profile_id	The ID of the specific browser profile to launch.	Yes
automation	Specify the automation framework: selenium, puppeteer, or playwright.	Optional
headless_mode	Set to true for headless mode or false for visible browser mode.	Optional

Example Configuration

With Automation

{
  "folder_id": "your_folder_id",
  "profile_id": "your_profile_id",
  "automation": "playwright",
  "headless_mode": false
}

Without Automation

{
  "folder_id": "your_folder_id",
  "profile_id": "your_profile_id"
}

Optional Parameters

If you don’t need automation or headless mode, deselect these parameters in the Postman request to simplify the payload.

Visual Reference

Below is a screenshot of the Postman interface with the GET Start Browser Profile request configured:

Running the Script

Once the request is configured, follow these steps to execute it:

1. Verify Agent Connection Confirm that the agent is running and connected. Without an active agent, the profile cannot be launched.

2. Send the Request In Postman, click the Send button to execute the request.

3. Check the Response A 200 OK status code indicates a successful request. If automation is enabled, the response will include the port for your specified framework (e.g., Selenium, Puppeteer, or Playwright).

Troubleshooting

If you receive an error, verify the following:

• The folder_id and profile_id are correct.
• The bearer token is valid and included in the request headers.
• The agent is connected and operational.