Skip to main content
GET
/
browser
/
sessions
/
{id}
/
live-view
Live View
curl --request GET \
  --url https://api.example.com/browser/sessions/{id}/live-view
{
  "url": "<string>"
}

Overview

Returns a URL that loads an in-browser noVNC client connected to the session’s virtual desktop. Useful for:
  • Debugging task failures by watching the actual browser in real time.
  • Handing control to an end-user for authenticate actions in prompt_user mode.
  • Internal monitoring tools.
The URL is scoped to the session’s lifetime and becomes invalid once the session is destroyed.

Path Parameters

id
string
required
Browser session ID (UUID).

Example Request

curl -X GET "https://api.scrapengine.io/api/v1/browser/sessions/baa3f390-fa6e-4a24-b84a-a575a5f3a9c7/live-view" \
  -H "Authorization: Bearer $SCRAPENGINE_API_KEY"

Response

Success Response (200)

url
string
Shareable live-view URL. Open in any modern browser.
Example Response:
{
  "url": "https://live.scrapengine.io/baa3f390-fa6e-4a24-b84a-a575a5f3a9c7?token=..."
}

Error Responses

StatusDescription
401Unauthorized — invalid or missing API key.
404Session not found or not owned by the caller.