Get Shell

Mint a short-lived terminal URL. User opens it in a browser → live shell.

launch controls what runs when the terminal connects:

• “bash” (default) → plain login shell.
• “claude” → auto-run the claude UI; Ctrl+C drops to bash.

w (optional) selects which tmux window to attach to (e.g. bux-w2). Defaults to bux-w1 — the box-agent auto-creates that window on first attach so single-window callers see no behavior change.

POST /boxes/me/shell

Get Shell

JavaScript

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

fetch('https://api.browser-use.com/api/v3/boxes/me/shell', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api.browser-use.com/api/v3/boxes/me/shell \
  --header 'X-Browser-Use-API-Key: <api-key>'

import requests

url = "https://api.browser-use.com/api/v3/boxes/me/shell"

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

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

print(response.text)

200

{
  "url": "<string>",
  "expires_in_seconds": 900
}

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

Authorizations

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

Query Parameters

launch · string · default: bash

w · string | null

Response

200

application/json

Successful Response

Terminal URL — user opens this in their browser, gets a live shell.

url · string · required

expires_in_seconds · integer · default: 900