v1

latestOpenAPI 3.1.02026-07-138112134.9 KB

Navigate to a URL

Navigates the browser to the specified URL.

post/v1/sessions/{id}/navigate

Path parameters

idstring required

Unique session identifier

Example:c4dbf3a9-9a58-4b22-8a1c-9f20f9f9e123

Unique session identifier

Headers

x-stream-response'true' | 'false'

Whether to stream the response via SSE

Example:true

Whether to stream the response via SSE

Request body

urlstring required

URL to navigate to

frameIdstring nullable

Target frame ID for the navigation

streamResponseboolean

Whether to stream the response via SSE

Example request

{
  "url": "https://example.com",
  "options": {
    "timeout": 30000,
    "waitUntil": "networkidle"
  },
  "streamResponse": true
}

Response

Default Response

successboolean required

Indicates whether the request was successful