Skip to main content
POST
/
boxes
/
me
/
restart
Restart My Box
const options = {
  method: 'POST',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({mode: 'service'})
};

fetch('https://api.browser-use.com/api/v3/boxes/me/restart', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "size": "small",
  "size_spec": {
    "name": "small",
    "vcpu": 123,
    "ram_gb": 123,
    "disk_gb": 123,
    "daily_usd": 123,
    "min_balance_usd": 123
  },
  "ec2_instance_id": "<string>",
  "public_ip": "<string>",
  "status": "provisioning",
  "status_detail": "<string>",
  "claude_authed": true,
  "tg_installed": true,
  "tg_bot_username": "<string>",
  "dsp_enabled": true,
  "live_browser_url": "<string>",
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "trial_ends_at": "2023-11-07T05:31:56Z"
}

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

Body

application/json
​
mode
enum<string>
default:service

How aggressive a /me/restart should be.

service — fastest, fixes ~95% of cases (agent process crash, OOM, wedged TG long-poll). SSM systemctl restart bux-tg. ~5s. reboot — fallback for kernel-hung / SSM-unreachable boxes. AWS rebootInstances. ~30-60s. IP + EBS preserved.

Available options:
service,
reboot

Response

Successful Response

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
profile_id
string<uuid> | null
required
​
size
enum<string>
required
Available options:
small,
medium,
large
​
size_spec
BoxSizeSpecView · object
required

User-visible spec sheet for one size tier. Returned alongside BoxView so the UI can render the tooltip ("2 vCPU · 4 GB · 20 GB") without a second round trip + so the picker on /bux can show all three rows without us hardcoding prices in the frontend.

​
ec2_instance_id
string | null
required
​
public_ip
string | null
required
​
status
enum<string>
required
Available options:
provisioning,
awaiting_oauth,
ready,
resizing,
error,
halted,
destroyed
​
status_detail
string | null
required
​
claude_authed
boolean
required
​
tg_installed
boolean
required
​
tg_bot_username
string | null
required
​
dsp_enabled
boolean
required
​
live_browser_url
string | null
required
​
last_heartbeat_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
trial_ends_at
string<date-time> | null