Create browser session
create_sessionCreate a persistent session in a real Chrome browser running in a WebRun cloud environment (docs.webrun.ai), for multi-step interactive work. Returns a sessionId for subsequent commands. With an initial task the browser may act on third-party websites immediately. Do NOT use this to run or test a saved workflow — use trigger_workflow instead: only a workflow run carries the workflow's own rules, tracking and memory, so a session run will behave differently.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Session mode (default: default) | |
| task | No | Initial task configuration | |
| model | No | Optional model name or profile key (from global config). Falls back to the configured default. | |
| proxy | No | Proxy configuration. WebRun-managed: { source: "WebRun", country: "GB" }. Custom: { source: "custom", type: "http"|"socks", host, port, username?, password? }. Omit for no proxy. | |
| debugC | No | Enable debug mode on the instance (default: false) | |
| policyId | No | Policy ID to apply automation guardrails (domain restrictions, capability controls, LLM role). Optional. | |
| timezone | No | IANA timezone name for the session, e.g. "America/New_York", "Europe/London", "Asia/Tokyo". Date/time-sensitive instructions (e.g. "tomorrow morning", "today", "in 2 hours") are interpreted in this timezone. Defaults to "UTC" when omitted. | |
| environmentId | No | Environment ID for persistent profile session. Use list_environments to find available IDs. Without this, a disposable instance is used. | |
| reach_out_mode | No | Controls proactive chat-platform messages (Telegram/WhatsApp/Slack/Discord/Teams) to bot users on the same environment. Default: "off" — no messages are sent unless this is set explicitly. "guardrail_only" forwards guardrail prompts (CAPTCHA/2FA/verification) to chat when the API caller is offline. "full" also forwards the task result on completion. Each bot user additionally filters by their own reachOutMode preference. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| taskId | No | Task ID when an initial task was provided | |
| message | No | ||
| sessionId | Yes | Session ID for subsequent commands | |
| streaming | No | Endpoints for watching the running browser. Only liveViewURL is a web page — the other two are machine endpoints on a non-standard port. | |
| environment | No | Environment this session is bound to, when one was requested |