List Workspace Files

List files in a workspace’s S3 prefix.

GET /workspaces/{workspace_id}/files

List Workspace Files

JavaScript

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

fetch('https://api.browser-use.com/api/v3/workspaces/{workspace_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "files": [
    {
      "path": "<string>",
      "size": 123,
      "lastModified": "2023-11-07T05:31:56Z",
      "url": "<string>"
    }
  ],
  "folders": [
    "<string>"
  ],
  "nextCursor": "<string>",
  "hasMore": false
}

Authorizations

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

Path Parameters

workspace_id · string<uuid> · required

Query Parameters

prefix · string · default: ""

limit · integer · default: 50

Required range: 1 <= x <= 100

cursor · string | null

includeUrls · boolean · default: false

shallow · boolean · default: false

Response

200

application/json

Successful Response

Paginated file listing with optional presigned download URLs.

files · FileInfo · object[] · required

Show child attributes

folders · string[]

Immediate sub-folder names at this prefix level

nextCursor · string | null

hasMore · boolean · default: false