Start a script run on given profiles; returns the run immediately (its `id` is the run_id).

Starts the script on the given profiles in the background: each profile's browser opens and the script drives it. An unapproved script runs on at most 3 profiles and without the profiles' stored variables. Returns the run at once; read its result with GET /v1/runs/:id.

post/v1/scripts/run

Request

  • Base URL: http://127.0.0.1:10108
  • URL: http://127.0.0.1:10108/v1/scripts/run
  • Auth: HTTP bearer

Request body

headlessboolean

Launch the run's profiles headless, without a window — the same launch as launch_profile's headless (see there): the profile's fingerprint is unchanged. Default false.

profile_idsstring[]
script_idstring uuid required
variablesobject

Response

The run as recorded now, still running; poll GET /v1/runs/:id with its id.

completedAtstring date-time nullable required
errorstring nullable required
idstring uuid required
profileIdsstring[] required
profilesDoneinteger required
profilesFailedinteger required
profilesTotalinteger required
scheduleIdstring uuid nullable required
scriptIdstring uuid nullable required
source'schedule' | 'app' | 'agent' | 'null' nullable required
startedAtstring date-time required
status'running' | 'completed' | 'partial' | 'failed' | 'skipped' required

Changes

No recorded changes to this operation across all 1 revision of this API.