Skip to main content
PATCH
/
workspaces
/
{workspace_id}
Update Workspace
const options = {
  method: 'PATCH',
  headers: {'X-Browser-Use-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.browser-use.com/api/v3/workspaces/{workspace_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "name": "<string>"
}

Authorizations

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

Path Parameters

​
workspace_id
string<uuid>
required

Body

application/json

Request model for updating a workspace.

​
name
string | null

Optional name for the workspace

Maximum string length: 100

Response

Successful Response

View model for a workspace — persistent shared storage across sessions.

​
id
string<uuid>
required

Unique identifier for the workspace

​
createdAt
string<date-time>
required

Timestamp when the workspace was created

​
updatedAt
string<date-time>
required

Timestamp when the workspace was last updated

​
name
string | null

Optional name for the workspace