FeaturePOST /v1/journey

Browser Journeys

Flows a single check cannot cover: click, type, wait, extract — all in one call.

What you can do with journeys

Multi-step browser sessions: navigate, click, type, extract, screenshots — all in one call. For flows a single GET/check cannot cover.

Steps: navigate, interact, extract, visibility, screenshot, evaluate, …
Optional capture_xhr and solve_captcha across the session
Debug screenshots on errors
Set cookies and viewport for the entire session
Final URL + step results for assertions in CI

API Call

editable

Request body

{'{'}

{'}'}

Demo starts with navigate to the URL. Click values to edit them.

Response

navigate

https://example.com

Endpoints & parameters

Choose an endpoint — below you'll see an example request and explanations for all relevant parameters.

POST /v1/journey

Runs a step list in one browser session.

Example request

json

{
  "width": 1280,
  "height": 720,
  "dismiss_cookie_banner": true,
  "debug": {
    "on_error_only": true,
    "format": "jpeg",
    "quality": 80
  },
  "steps": [
    {
      "type": "navigate",
      "url": "https://example.com"
    },
    {
      "type": "interact",
      "action": "click",
      "selector": "a[href=\"/pricing\"]"
    },
    {
      "type": "extract",
      "fields": [
        {
          "name": "h1",
          "selector": "h1",
          "type": "text"
        }
      ]
    },
    {
      "type": "screenshot",
      "mode": "viewport",
      "format": "jpeg"
    }
  ]
}

Parameters

stepsarray (1–40) required
Sequence of step objects (type + fields per type).
steps[].typeenum
navigate | set_content | interact | extract | visibility | screenshot | evaluate | wait_for_function.
interact.actionenum
click, type, fill, scroll, hover, press_key, select_option, wait, wait_for_selector.
width / heightnumber
Session viewport.
user_agent / headers / cookiesvarious
Session context.
debugboolean | object
Debug screenshots; on_error_only, format, quality.
dismiss_cookie_bannerboolean
Dismiss cookie banner before steps.