Sign in

v1

latestOpenAPI 3.0.02026-07-26300209.6 KB
Automation

Run browser automation with SSE streaming

Execute a browser automation task with Server-Sent Events (SSE) streaming. Returns a real-time event stream with automation progress, browser streaming URL, and final results.

post/v1/automation/run-sse

Request body

urlstring uri required

Target website URL to automate

goalstring required

Natural language description of what to accomplish on the website

browser_profile'lite' | 'stealth'

Browser profile for execution. LITE uses standard browser, STEALTH uses anti-detection browser.

api_integrationstring

Name of the integration making this API call (e.g., "dify", "zapier", "n8n"). Used for analytics.

webhook_urlstring uri

HTTPS URL to receive webhook notifications for run lifecycle events. Must use HTTPS.

use_vaultboolean

Opt-in to vault credentials for this run. When true, enabled vault items are included. Defaults to false.

use_profileboolean

Opt-in to the default Browser Context Profile if Browser Context Profiles are enabled; legacy callers are silently ignored when the profiles feature is disabled. Returns 400 when enabled but no default profile is set.

profile_idstring

Browser Context Profile ID to use when use_profile is true.

credential_item_idsstring[]

Scope vault credentials to specific credential URIs. Requires use_vault to be true. If omitted with use_vault: true, all enabled items are used.

output_schemaobject

Optional provider-supported structured-output schema subset for the run result. Unsupported fields are rejected before the request is accepted.

Example request

{
  "url": "https://example.com",
  "goal": "Find the pricing page and extract all plan details",
  "browser_profile": "lite",
  "api_integration": "dify",
  "agent_config": {
    "mode": "strict",
    "cursor_style": "standard",
    "max_steps": 50,
    "max_duration_seconds": 300
  },
  "use_vault": true,
  "use_profile": true,
  "profile_id": "prof_abc123def4567890",
  "credential_item_ids": [
    "cred:conn-abc:Work:item-123",
    "cred:conn-def:Personal:item-456"
  ],
  "proxy_config": {
    "enabled": true,
    "country_code": "US"
  },
  "output_schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "price": {
        "type": "number"
      }
    },
    "required": [
      "title",
      "price"
    ]
  }
}

Response

Server-Sent Events stream. Stream sends STARTED, STREAMING_URL (optional), PROGRESS (intermediate events with purpose), COMPLETE events, plus periodic HEARTBEAT messages.