Skip to content

Launcher API

The Launcher API runs on the local Multilogin X Agent and handles browser profile lifecycle operations.

Base URL: https://launcher.mlx.yt:45001

WARNING

The Multilogin X Agent must be installed and running for these endpoints to work.

Start Browser Profile

GET /api/v1/profile/f/:folder_id/p/:profile_id/start

Start a browser profile. Optionally specify automation type for Selenium/Playwright/Puppeteer integration.

ParameterLocationRequiredDescription
folder_idpathYesUUID of the folder containing the profile
profile_idpathYesUUID of the profile to start
automation_typequeryNoselenium, playwright, or puppeteer
headless_modequeryNotrue to start headless
bash
# Start with Selenium automation
curl "https://launcher.mlx.yt:45001/api/v1/profile/f/FOLDER_ID/p/PROFILE_ID/start?automation_type=selenium" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Response (returns Selenium port in message):

json
{
  "status": {
    "error_code": "",
    "http_code": 200,
    "message": "54499"
  }
}

Start Quick Profile

GET /api/v1/profile/quick/start

Start a temporary quick profile that is not saved after closing.

ParameterLocationRequiredDefaultDescription
profile_namequeryYesName for the quick profile
browser_typequeryNomimicmimic or stealthfox
os_typequeryNowindowswindows, macos, linux, android
automation_typequeryNoselenium, playwright, puppeteer
is_headlessqueryNofalseRun headless
folder_idqueryYesUUID of target folder
bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/quick/start?profile_name=temp-profile&browser_type=mimic&folder_id=FOLDER_ID" \
  -H "Authorization: Bearer YOUR_TOKEN"

Stop Browser Profile

GET /api/v1/profile/stop/p/:profile_id

Stop a running browser profile.

bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/stop/p/PROFILE_ID" \
  -H "Authorization: Bearer YOUR_TOKEN"

Stop All Profiles

GET /api/v1/profile/stop/all

Stop all currently running browser profiles.

bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/stop/all" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Active Profiles

GET /api/v1/profile/active

Returns a list of currently running browser profiles.

bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/active" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Profile by WebSocket Debugger URL

GET /api/v1/profile/p/:profile_id/ws_debugger_url

Get the Chrome DevTools Protocol WebSocket debugger URL for a running profile.

bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/p/PROFILE_ID/ws_debugger_url" \
  -H "Authorization: Bearer YOUR_TOKEN"

Lifecycle Flow

Headless Mode

Start profiles without a visible browser window:

bash
curl "https://launcher.mlx.yt:45001/api/v1/profile/f/FOLDER_ID/p/PROFILE_ID/start?automation_type=selenium&headless_mode=true" \
  -H "Authorization: Bearer YOUR_TOKEN"

Common Launcher Errors

ErrorCauseSolution
Connection refusedAgent not runningStart the Multilogin X Agent
Profile already runningDuplicate startStop the profile first, then restart
Invalid folder/profile IDWrong UUIDVerify IDs via Cloud API
Port conflictPort in useThe agent assigns ports dynamically