Skip to main content
POST
/
boxes
Provision Box
const options = {
  method: 'POST',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', size: 'small'})
};

fetch('https://api.browser-use.com/api/v3/boxes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "box": {
    "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
profile_id
string<uuid> | null
size
enum<string> | null
Available options:
small,
medium,
large

Response

Successful Response

box
BoxView · object
required