Sign in

v6

OpenAPI 3.0.4raw.githubusercontent.com2026-07-1500143.2 KB
Profile

Starts the selected profile by transitioning its status to 'starting', launching the kernel (Chroma or Junglefox) associated with the profile, and then changing its status to 'running'. If there is an error during start-up, it will be 'terminated'. Note that the required kernel might not be available locally, so it may be downloaded during the profile start. Optional command line arguments or settings can be passed to the browser engines.

post/profiles/{profileId}/start

Path parameters

profileIdstring uuid required

The unique identifier of the profile

Request body

argumentsstring[] nullable

Command line arguments that can be passed to the browser at startup. This applies to both Chroma and Junglefox browsers. Do not include the starting double dash (--).

Example request

{
  "arguments": [
    "disable-notifications"
  ],
  "preferences": [
    {
      "key": "signin.allowed_on_next_startup",
      "value": false
    }
  ],
  "additionalOptions": [
    {
      "key": "profile.managed_default_content_settings.images",
      "value": 2
    }
  ]
}

Response

OK.

lifetimeState'created' | 'starting' | 'running' | 'terminating' | 'terminated' | 'locked' | 'loading' | 'unknown' required

Represents the lifetime states of a profile, indicating which actions can be performed with the associated browser engine at each state. Possible values are:

  • Created: Profile is created; the associated browser engine is not started.
  • Starting: The associated browser engine is starting.
  • Running: The associated browser engine is currently running.
  • Terminating: The associated browser engine is in the process of terminating.
  • Terminated: The associated browser engine is not running but has been started at least once.
  • Locked: The profile is currently being used by another user.
  • Loading: The profile data or the browser engine is syncing with the cloud storage.
  • Unknown: State of the profile is undefined.