Update Box Agent

Tell the box-agent to git-pull + restart from the OSS repo.

Default branch is whatever the box is currently tracking (the agent resolves it from git rev-parse --abbrev-ref HEAD); pass branch=main or branch=stable to switch tracks.

Returns the old + new SHA so the FE can show “updated to a3f9c1d”. The agent restarts itself at the tail of the update — the next hello will report the new version. We wait up to 90s for the update_result reply since git fetch + bootstrap.sh can stretch on slow networks.

POST /boxes/me/update

Update Box Agent

JavaScript

const options = {method: 'POST', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v3/boxes/me/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

422

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

Authorizations

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

Query Parameters

branch · string | null

Response

200

application/json

Successful Response