Skip to main content
POST
/
boxes
/
me
/
shell
Get Shell
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));
{
  "url": "<string>",
  "expires_in_seconds": 900
}

Documentation Index

Fetch the complete documentation index at: https://docs.browser-use.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Query Parameters

​
launch
string
default:bash
​
w
string | null

Response

Successful Response

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

​
url
string
required
​
expires_in_seconds
integer
default:900