Session Live URLs

GET

sessions

{id}

debug

Session Live URLs

curl --request GET \
  --url https://api.browserbase.com/v1/sessions/{id}/debug \
  --header 'X-BB-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-BB-API-Key': '<api-key>'}};

fetch('https://api.browserbase.com/v1/sessions/{id}/debug', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/sessions/{id}/debug",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/sessions/{id}/debug"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/sessions/{id}/debug")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "debuggerFullscreenUrl": "<string>",
  "debuggerUrl": "<string>",
  "pages": [
    {
      "id": "<string>",
      "url": "<string>",
      "faviconUrl": "<string>",
      "title": "<string>",
      "debuggerUrl": "<string>",
      "debuggerFullscreenUrl": "<string>"
    }
  ],
  "wsUrl": "<string>"
}

Authorizations

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Path Parameters

string

required

Query Parameters

expiresIn

integer

Time-to-live of the generated live view URLs, in seconds. If omitted, the URLs expire with the session, up to a maximum of 21600 seconds (6 hours).

Required range: 60 <= x <= 21600

Response

200 - application/json

The request has succeeded.

debuggerFullscreenUrl

string<uri>

required

debuggerUrl

string<uri>

required

pages

object[]

required

Show child attributes

wsUrl

string<uri>

required

⌘I

Session Live URLs

curl --request GET \
  --url https://api.browserbase.com/v1/sessions/{id}/debug \
  --header 'X-BB-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-BB-API-Key': '<api-key>'}};

fetch('https://api.browserbase.com/v1/sessions/{id}/debug', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/sessions/{id}/debug",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/sessions/{id}/debug"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/sessions/{id}/debug")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "debuggerFullscreenUrl": "<string>",
  "debuggerUrl": "<string>",
  "pages": [
    {
      "id": "<string>",
      "url": "<string>",
      "faviconUrl": "<string>",
      "title": "<string>",
      "debuggerUrl": "<string>",
      "debuggerFullscreenUrl": "<string>"
    }
  ],
  "wsUrl": "<string>"
}

Overview

SDKs

APIs

Authorizations

Path Parameters

Query Parameters

Response