Create Agent Workspace

Create an agent workspace. Pass its id into runs to share one disk across sessions.

POST /agent-workspaces

Create Agent Workspace

JavaScript

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

fetch('https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agent-workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agent-workspaces \
  --header 'Content-Type: application/json' \
  --header 'X-Browser-Use-API-Key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1/agent-workspaces"

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

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

print(response.text)

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>"
}

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

Authorizations

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

Body

application/json

name · string | null

Human-readable label for the workspace.

Maximum string length: 100

Response

201

application/json

Successful Response

id · string<uuid> · required

Workspace id — pass this to share a disk across runs.

createdAt · string<date-time> · required

When the workspace was created.

name · string | null

Human-readable label, if set.