Use this endpoint to check if the server is running and responding.

Ping

Browser Use

Welcome to Browser Use - We enable AI to control your browser

Introduction

Start using Browser Use with this quickstart guide

Quickstart

Guide to using different LangChain chat models with Browser Use

Supported Models

Agent Settings

Configure browser behavior and context settings

Browser Settings

With this you can connect to your real browser, where you are logged in with all your accounts.

Connect to your Browser

The default is text. But you can define a structured output format to make post-processing easier.

Output Format

Customize the system prompt to control agent behavior and capabilities

System Prompt

Handle sensitive information securely by preventing the model from seeing actual passwords.

Sensitive Data

Extend default agent and write custom function calls

Custom Functions

Set up Browser Use development environment locally

Local Setup

Understanding Browser Use's telemetry and privacy settings

Telemetry

Trace Browser Use's agent execution steps and browser sessions

Observability

Future plans and upcoming features for Browser Use

Roadmap

Learn how to get started with the Browser Use Cloud API

Learn how to implement the Browser Use API in Python

Implementing the API

Requires an active subscription. Returns the task ID that can be used to track progress.

Run Task

Stops a running browser automation task immediately. The task cannot be resumed after being stopped.
Use `/pause-task` endpoint instead if you want to temporarily halt execution.

Stop Task

Pauses execution of a running task. The task can be resumed later using the `/resume-task` endpoint. Useful for manual intervention or inspection.

Pause Task

Resumes execution of a previously paused task. The task will continue from where it was paused. You can't resume a stopped task.

Resume Task

Returns comprehensive information about a task, including its current status, steps completed, output (if finished), and other metadata.

Get Task

Returns just the current status of a task (created, running, finished, stopped, or paused).
More lightweight than the full task details endpoint.

Get Task Status

Returns links to any recordings or media generated during task execution,
such as browser session recordings. Only available for completed tasks.

Get Task Media

Returns any screenshot urls generated during task execution.

Get Task Screenshots

Returns a gif url generated from the screenshots of the task execution.
Only available for completed tasks that have screenshots.

Get Task Gif

Returns a paginated list of all tasks belonging to the user, ordered by creation date.
Each task includes basic information like status and creation time. For detailed task info, use the
get task endpoint.

List Tasks

Returns the user's current API credit balance, which includes both monthly subscription
credits and any additional purchased credits. Required for monitoring usage and ensuring sufficient
credits for task execution.

Check Balance

Returns a boolean value indicating if the API key is valid and the user is authenticated.

Cloud API

API v1.0

Ping

Response