Get Browser

Get one browser: status, cdpUrl, liveViewUrl, and the agent session (if any).

GET /browsers/{browser_id}

Get Browser

JavaScript

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

fetch('https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browsers/{browser_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browsers/{browser_id} \
  --header 'X-Browser-Use-API-Key: <api-key>'

import requests

url = "https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/browsers/{browser_id}"

headers = {"X-Browser-Use-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "cdpUrl": "<string>",
  "liveViewUrl": "<string>",
  "agentSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-Browser-Use-API-Key · string · header · required

Path Parameters

browser_id · string<uuid> · required

Response

200

application/json

Successful Response

id · string<uuid> · required

status · enum<string> · required

'active' (running) or 'stopped'.

Available options: active, stopped

createdAt · string<date-time> · required

cdpUrl · string | null

Chrome DevTools Protocol endpoint. Null until the browser is booted.

liveViewUrl · string | null

Watch the browser live in a tab. Null until booted.

agentSessionId · string<uuid> | null

The agent session that used this browser, if any.