Skip to main content
PATCH
/
boxes
/
me
/
windows
/
{window_id}
Windows Rename
const options = {
  method: 'PATCH',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>'})
};

fetch('https://api.browser-use.com/api/v3/boxes/me/windows/{window_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "label": "",
  "attached": false,
  "created_at": 0
}

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

Path Parameters

​
window_id
string
required

Body

application/json
​
label
string
required

Response

Successful Response

One tmux window on the box. id is the tmux session name (bux-w<n>).

label is a user-supplied name (max 64 chars) stored as a tmux per-session option (@bux-label). attached is True if any tmux client is currently connected to the window. The FE shows a small indicator next to attached windows so users know which one a phone is currently mirroring.

​
id
string
required
​
label
string
default:""
​
attached
boolean
default:false
​
created_at
integer
default:0