How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Browser Use

Browser Use Public API v3

The session-based Browser Use Cloud REST API — agent sessions with streamed messages, standalone CDP browsers, persistent workspaces and files, browser profiles, billing account balance, and an x402 machine-payment balance endpoint. 27 operations, OpenAPI 3.1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Browser Use Public API v3 is one of 4 APIs that Browser Use publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Browser Automation, Sessions, and Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 27 operations across 16 paths, organized into 6 resource areas, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.browser-use.com/api/v3.

27 operations 16 paths 47 schemas 4 DELETE13 GET3 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.browser-use.com/api/v3
Authentication
API Key
Resource Areas
6

Authentication & Security 1

Browser Use Public API v3 declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Browser-Use-API-Key (APIKeyHeader).

Paths & Operations 27

Across 16 paths, the API surfaces 27 operations — 4 DELETE, 13 GET, 3 PATCH, 7 POST. They span 6 resource areas: Sessions, Browsers, Profiles, Workspaces, Billing, x402. Each is listed below with its method, path, parameters, and response codes.

Sessions 6
POST
/sessions
Create Session
create_session_sessions_post body → 200422
GET
/sessions
List Sessions
list_sessions_sessions_get 2 params → 200422
GET
/sessions/{session_id}
Get Session
get_session_sessions__session_id__get 1 param → 200422
DELETE
/sessions/{session_id}
Delete Session
delete_session_sessions__session_id__delete 1 param → 204422
POST
/sessions/{session_id}/stop
Stop Session
stop_session_sessions__session_id__stop_post 1 param body → 200422
GET
/sessions/{session_id}/messages
List Session Messages
list_session_messages_sessions__session_id__messages_get 4 params → 200422
Browsers 5
GET
/browsers
List Browser Sessions
list_browser_sessions_browsers_get 5 params → 200422
POST
/browsers
Create Browser Session
create_browser_session_browsers_post body → 201403404422429
GET
/browsers/{session_id}
Get Browser Session
get_browser_session_browsers__session_id__get 1 param → 200404422
PATCH
/browsers/{session_id}
Update Browser Session
update_browser_session_browsers__session_id__patch 1 param body → 200404422
GET
/browsers/{session_id}/downloads
List Browser Session Downloads
list_browser_session_downloads_browsers__session_id__downloads_get 4 params → 200404422
Profiles 5
GET
/profiles
List Profiles
list_profiles_profiles_get 3 params → 200422
POST
/profiles
Create Profile
create_profile_profiles_post body → 201402422
GET
/profiles/{profile_id}
Get Profile
get_profile_profiles__profile_id__get 1 param → 200404422
PATCH
/profiles/{profile_id}
Update Profile
update_profile_profiles__profile_id__patch 1 param body → 200404422
DELETE
/profiles/{profile_id}
Delete Browser Profile
delete_browser_profile_profiles__profile_id__delete 1 param → 204422
Workspaces 9
GET
/workspaces
List Workspaces
list_workspaces_workspaces_get 2 params → 200422
POST
/workspaces
Create Workspace
create_workspace_workspaces_post body → 201422
GET
/workspaces/{workspace_id}
Get Workspace
get_workspace_workspaces__workspace_id__get 1 param → 200422
PATCH
/workspaces/{workspace_id}
Update Workspace
update_workspace_workspaces__workspace_id__patch 1 param body → 200422
DELETE
/workspaces/{workspace_id}
Delete Workspace
delete_workspace_workspaces__workspace_id__delete 1 param → 204422
GET
/workspaces/{workspace_id}/files
List Workspace Files
list_workspace_files_workspaces__workspace_id__files_get 6 params → 200422
DELETE
/workspaces/{workspace_id}/files
Delete Workspace File
delete_workspace_file_workspaces__workspace_id__files_delete 2 params → 204422
GET
/workspaces/{workspace_id}/size
Get Workspace Size
get_workspace_size_workspaces__workspace_id__size_get 1 param → 200422
POST
/workspaces/{workspace_id}/files/upload
Upload Workspace Files
upload_workspace_files_workspaces__workspace_id__files_upload_post 2 params body → 200422
Billing 1
GET
/billing/account
Get Account Billing
get_account_billing_billing_account_get → 200404422
x402 1
POST
/x402/balance
X402 Balance
x402_balance_x402_balance_post body → 200422

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are SessionResponse (30 properties), RunTaskRequest (21 properties), BrowserSessionView (14 properties), BrowserSessionItemView (13 properties). Each schema is shown below with its type and property counts.

AccountNotFoundError
object
Error response when an account is not found
1 property
AccountView
object
View model for account information.
11 properties 8 required
BrowserDownloadFile
object
A single file the browser downloaded during the session.
4 properties 3 required
BrowserDownloadListResponse
object
Paginated list of browser downloads with optional presigned URLs.
3 properties 1 required
BrowserSessionItemView
object
View model for representing a browser session in list views.
13 properties 4 required
BrowserSessionListResponse
object
Response model for paginated browser session list requests.
4 properties 4 required
BrowserSessionStatus
string
Enumeration of possible browser session states Attributes: ACTIVE: Session is currently active and running (browser is running) STOPPED: Session has been stopp…
BrowserSessionUpdateAction
string
Available actions that can be performed on a browser session Attributes: STOP: Stop the browser session (cannot be undone)
BrowserSessionView
object
View model for representing a browser session.
14 properties 4 required
BuAgentSessionStatus
string
Session lifecycle status. Progresses through: created → idle → running → idle → ... → stopped / timedout / error. - created: Sandbox is starting up. The sessio…
BuModel
string
The model to use for the agent. Each model has different capabilities and pricing. - bu-mini / gemini-3-flash: Gemini 3 Flash — fast and cost-effective. Best f…
CreateBrowserSessionRequest
object
Request model for creating a browser session.
9 properties
CustomProxy
object
Request model for creating a custom proxy.
5 properties 2 required
FileInfo
object
A file in a session's workspace.
4 properties 3 required
FileListResponse
object
Paginated file listing with optional presigned download URLs.
4 properties 1 required
FileUploadItem
object
A single file to upload.
3 properties 1 required
FileUploadRequest
object
Request body for generating presigned upload URLs.
1 property 1 required
FileUploadResponse
object
Presigned upload URLs for the requested files.
1 property 1 required
FileUploadResponseItem
object
Presigned upload URL for a single file.
3 properties 3 required
HTTPValidationError
object
1 property
InsufficientCreditsError
object
Error response when there are insufficient credits
1 property
MessageListResponse
object
2 properties 2 required
MessageResponse
object
A single message from the session's message stream. Messages represent the agent's actions, observations, and decisions as it executes a task.
9 properties 5 required
PlanInfo
object
View model for plan information
5 properties 5 required
ProfileCreateRequest
object
Request model for creating a new profile.
2 properties
ProfileListResponse
object
Response model for paginated profile list requests.
4 properties 4 required
ProfileNotFoundError
object
Error response when a profile is not found
1 property
ProfileUpdateRequest
object
Request model for updating a profile.
2 properties
ProfileView
object
View model for representing a profile. A profile lets you preserve the login state between sessions. We recommend that you create a separate profile for each u…
7 properties 3 required
ProxyCountryCode
string
RunTaskRequest
object
Create a new session, dispatch a task, or both. - No sessionId + no task: creates an idle session (useful for uploading files before running a task). - No sess…
21 properties
SessionListResponse
object
4 properties 4 required
SessionNotFoundError
object
Error response when a session is not found
1 property
SessionResponse
object
Represents a session and its current state. Poll this endpoint to track task progress. The status field indicates the session lifecycle stage, and output conta…
30 properties 5 required
SessionTimeoutLimitExceededError
object
Error response when session timeout exceeds the maximum allowed limit
1 property
StopSessionRequest
object
1 property
StopStrategy
string
Strategy for stopping a session. - task: Stop the currently running task but keep the session alive in idle state. You can dispatch another task to the same se…
ThinkingLevel
string
Provider-neutral model reasoning depth.
TooManyConcurrentActiveSessionsError
object
Error response when user has too many concurrent active sessions
1 property
UpdateBrowserSessionRequest
object
Request model for updating browser session state.
1 property 1 required
ValidationError
object
3 properties 3 required
WorkspaceCreateRequest
object
Request model for creating a new workspace.
1 property
WorkspaceListResponse
object
Response model for paginated workspace list requests.
4 properties 4 required
WorkspaceUpdateRequest
object
Request model for updating a workspace.
1 property
WorkspaceView
object
View model for a workspace — persistent shared storage across sessions.
4 properties 3 required
X402BalanceRequest
object
Wallet-signature auth payload for a free, read-only balance check
4 properties 4 required
X402BalanceResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

browser-use-api-v3-openapi.json Raw ↑

Other APIs Browser Use publishes across the network.

Browser Use Public API v4
AE Profile APIs.io
Browser Use Public API v2
AE Profile APIs.io
Browser Use MCP Server
AE Profile APIs.io
#Browser Automation#Sessions#Workspaces
← Back to B APIs
API Details
ID
browser-use:browser-use-api-v3
Base URL
https://api.browser-use.com/api/v3
Docs
https://docs.browser-use.com/cloud/api-reference
Provider
Browser Use
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=browser-use-api-v3&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/browser-use-api-v3"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Browser Use Public API v3, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.