Resize My Box

Resize the project’s box to a larger tier (upgrade-only).

The actual stop → modify → start dance runs in a background task; this handler returns immediately with status=RESIZING. The FE polls /me to watch the box flip back to READY when the new instance is up. Takes ~60-90s end-to-end (stop ~30s, start ~30s, growpart instant).

Constraints enforced here:

• new size must be a known tier
• new size must be strictly larger than current (downsize → 400)
• box must be in READY state (otherwise → 409)
• project must clear the eligibility gate at the new size’s min-balance (a small box upgrading to large is now playing by large-box rules)

POST /boxes/me/resize

Resize My Box

JavaScript

const options = {
  method: 'POST',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.browser-use.com/api/v3/boxes/me/resize', 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/resize \
  --header 'Content-Type: application/json' \
  --header 'X-Browser-Use-API-Key: <api-key>' \
  --data '{}'

import requests

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

payload = {}
headers = {
    "X-Browser-Use-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "size_spec": {
    "vcpu": 123,
    "ram_gb": 123,
    "disk_gb": 123,
    "daily_usd": 123,
    "min_balance_usd": 123
  },
  "ec2_instance_id": "<string>",
  "public_ip": "<string>",
  "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"
}

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

Authorizations

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

Body

application/json

Resize an existing box to a larger tier.

Upgrade-only: the backend rejects requests where size isn't strictly larger than the box's current size. Downsize → 400 with a hint to destroy + redeploy. Same size → 409 (idempotent failure — no work to do).

size · enum<string> · required

Available options: small, medium, large

Response

200

application/json

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.

Show child attributes

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