Skip to main content
Browser Use logo

​
Overview

Add Browser Use to any ModuleX agent or workflow. AI-powered cloud browser automation via the Browser Use REST API (api.browser-use.com/api/v3). Create agent sessions to perform web tasks, manage standalone browser sessions via CDP, and organize persistent profiles and workspaces.
Categories: AI & Machine Learning · Automation · AI · Developer Tools & Infrastructure · Auth: API Key · Actions: 25

​
Authentication

​
API Key Authentication

Authenticate using your Browser Use API key
1

Step 1

Go to https://cloud.browser-use.com and sign in
2

Step 2

Navigate to your project settings or API Keys section
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Browser Use API KeyYour Browser Use API key from cloud.browser-use.comYesbu_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
task
string
Natural-language instruction for the agent
​
model
string
Browser Use agent model. Allowed values: claude-sonnet-4.6, claude-opus-4.6, gemini-3-flash, bu-mini, bu-max, bu-ultra (Default: claude-sonnet-4.6)
​
session_id
string
ID of an existing session to dispatch a follow-up task to
​
keep_alive
boolean
If true, the session stays idle after the task completes so it can accept follow-up tasks (Default: false)
​
max_cost_usd
string
Maximum total session cost in USD. Example: 1.50
​
profile_id
string
ID of a Browser Use profile to use
​
workspace_id
string
ID of a Browser Use workspace to attach
​
proxy_country_code
string
Lowercase proxy country code for browser traffic. Examples: us, de, jp. Enter none to disable proxy (Default: us)
​
output_schema
object
Optional JSON Schema for structured output
​
enable_scheduled_tasks
boolean
If true, the agent can create scheduled tasks tied to your project (Default: false)
​
sensitive_data
object
Key-value pairs available to the agent through secure placeholders. Keys are visible to the model; values are hidden
​
enable_recording
boolean
If true, Browser Use records the browser session and returns recording URLs after completion (Default: false)
​
skills
boolean
If true, enables built-in Browser Use agent skills such as file management (Default: true)
​
agentmail
boolean
If true, provisions a temporary email inbox for the session (Default: true)
​
cache_script
string
Controls deterministic script caching. Allowed values: auto, enabled, disabled (Default: auto)
​
use_own_key
boolean
If true, uses your configured LLM provider key instead of Browser Use managed keys (Default: false)
​
auto_heal
boolean
When script caching is active, validates cached script output and reruns the full agent if the result looks incorrect (Default: true)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "task": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task"
    },
    "live_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Live Url"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateSessionOutput",
  "type": "object"
}

​
Parameters

​
session_id
string
required
ID of the Browser Use agent session

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "task": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task"
    },
    "output": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Output"
    },
    "live_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Live Url"
    },
    "screenshot_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Screenshot Url"
    },
    "cost": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cost"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSessionOutput",
  "type": "object"
}

​
Parameters

​
page_number
integer
Page number to fetch. The first page is 1 (Default: 1)
​
page_size
integer
Number of records to return per page. Maximum: 100 (Default: 20)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "sessions": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Sessions",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSessionsOutput",
  "type": "object"
}

​
Parameters

​
session_id
string
required
ID of the Browser Use agent session to delete

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteSessionOutput",
  "type": "object"
}

​
Parameters

​
session_id
string
required
ID of the Browser Use agent session
​
strategy
string
Use task to stop only the current task and keep the session alive, or session to destroy the sandbox entirely. Allowed values: task, session (Default: session)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "StopSessionOutput",
  "type": "object"
}

​
Parameters

​
session_id
string
required
ID of the Browser Use agent session
​
after
string
Return messages after this message ID cursor
​
before
string
Return messages before this message ID cursor
​
limit
integer
Maximum number of messages to return. Maximum: 100 (Default: 10)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "messages": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Messages",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSessionMessagesOutput",
  "type": "object"
}

​
Parameters

​
profile_id
string
ID of a Browser Use profile
​
proxy_country_code
string
Lowercase proxy country code for browser traffic. Examples: us, de, jp. Enter none to disable proxy (Default: us)
​
timeout
integer
Session timeout in minutes. Supported range: 1 to 240 (Default: 60)
​
browser_screen_width
integer
Custom browser screen width in pixels. Supported range: 320 to 6144
​
browser_screen_height
integer
Custom browser screen height in pixels. Supported range: 320 to 3456
​
allow_resizing
boolean
Whether to allow browser resizing during the session (Default: false)
​
custom_proxy
object
Custom proxy object with host, port, username, and password fields. Requires an active subscription
​
enable_recording
boolean
If true, records the browser session (Default: false)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "live_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Live Url"
    },
    "cdp_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cdp Url"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateBrowserSessionOutput",
  "type": "object"
}

​
Parameters

​
browser_session_id
string
required
ID of the Browser Use browser session

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "live_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Live Url"
    },
    "cdp_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cdp Url"
    },
    "timeout": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Timeout"
    },
    "cost": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cost"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetBrowserSessionOutput",
  "type": "object"
}

​
Parameters

​
page_size
integer
Number of records to return per page. Maximum: 100 (Default: 20)
​
page_number
integer
Page number to fetch. The first page is 1 (Default: 1)
​
filter_by
string
Filter browser sessions by status. Allowed values: active, stopped

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Items",
      "type": "array"
    },
    "total_items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Items"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListBrowserSessionsOutput",
  "type": "object"
}

​
Parameters

​
browser_session_id
string
required
ID of the Browser Use browser session
​
action
string
required
Action to perform on the browser session. Currently supported value: stop (Default: stop)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateBrowserSessionOutput",
  "type": "object"
}

​
Parameters

​
name
string
Optional profile name. Maximum length: 100 characters
​
user_id
string
Optional internal user identifier from your system. Maximum length: 255 characters

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateProfileOutput",
  "type": "object"
}

​
Parameters

​
profile_id
string
required
ID of the Browser Use profile

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "User Id"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetProfileOutput",
  "type": "object"
}

​
Parameters

​
page_size
integer
Number of records to return per page. Maximum: 100 (Default: 20)
​
page_number
integer
Page number to fetch. The first page is 1 (Default: 1)
​
query
string
Search query for profile name or user ID. Maximum length: 200 characters

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Items",
      "type": "array"
    },
    "total_items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Items"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListProfilesOutput",
  "type": "object"
}

​
Parameters

​
profile_id
string
required
ID of the Browser Use profile to delete

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteProfileOutput",
  "type": "object"
}

​
Parameters

​
profile_id
string
required
ID of the Browser Use profile
​
name
string
Updated profile name. Maximum length: 100 characters
​
user_id
string
Updated internal user identifier. Maximum length: 255 characters

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "User Id"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateProfileOutput",
  "type": "object"
}

​
Parameters

​
name
string
Optional workspace name. Maximum length: 100 characters

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateWorkspaceOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetWorkspaceOutput",
  "type": "object"
}

​
Parameters

​
page_size
integer
Number of records to return per page. Maximum: 100 (Default: 20)
​
page_number
integer
Page number to fetch. The first page is 1 (Default: 1)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Items",
      "type": "array"
    },
    "total_items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total Items"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListWorkspacesOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace to delete

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteWorkspaceOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace
​
name
string
required
Updated workspace name. Maximum length: 100 characters

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateWorkspaceOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "size_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Size Bytes"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetWorkspaceSizeOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace
​
prefix
string
Optional directory prefix to list. Example: reports/
​
limit
integer
Maximum number of files to return. Maximum: 100 (Default: 50)
​
cursor
string
Pagination cursor from a previous response
​
include_urls
boolean
If true, include presigned download URLs for files (Default: false)
​
shallow
boolean
If true, list only immediate files and folders at the prefix (Default: false)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "files": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Files",
      "type": "array"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListWorkspaceFilesOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace
​
path
string
required
Relative workspace file path to delete. Example: reports/data.csv

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteWorkspaceFileOutput",
  "type": "object"
}

​
Parameters

​
workspace_id
string
required
ID of the Browser Use workspace
​
prefix
string
Optional directory prefix to upload into. Example: uploads/
​
files_json
string
required
JSON array of file metadata objects. Each object has name (required), contentType (optional), and size (optional integer). 1 to 10 files per request

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "files": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Files",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "UploadWorkspaceFilesOutput",
  "type": "object"
}

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetAccountBillingOutput",
  "type": "object"
}

​
Limits & Quotas

  • No publicly documented request rate limits at the time of writing.
  • Agent sessions are billed by runtime and model usage; max_cost_usd parameter available to cap spend per session.
  • Browser sessions are billed by runtime and can run up to 4 hours.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

HeyGen

Algolia

Amazon Alexa