Browser Use

Browser Use Sessions API

The Sessions API from Browser Use — 8 operation(s) for sessions.

GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sessions List AI agent sessions · List Sessions #
Ask an LLM
“Which AI agent sessions are currently active in my project?”
“Can I filter my agent sessions by status and page through them?”
Tell an agent
List my agent sessions with status {status}.
Show page {page} of my agent sessions, {size} at a time.
POST /sessions Start a new AI agent session · Create Session #
Ask an LLM
“How do I open an agent session that I can send several tasks to in turn?”
“Can a new agent session start on a given URL and use a saved browser profile?”
Tell an agent
Start an agent session at {start_url} using profile {profile}.
Open an agent session with a {country} proxy and keep-alive set to {keep_alive}.
GET /sessions/{session_id} Get an agent session's status and tasks · Get Session #
Ask an LLM
“What's the live URL and current status of my agent session?”
“Which tasks has an agent session run so far?”
Tell an agent
Show the details and task list of agent session {session_id}.
Get the live URL for agent session {session_id}.
PATCH /sessions/{session_id} Stop a session via the update action · Update Session #
Ask an LLM
“Can I stop an agent session and all its running tasks by updating the session with an action?”
“Is stopping a session through the update endpoint reversible?”
Tell an agent destructive · confirm first
Update agent session {session_id} with action {action} to halt it and every running task.
Send the stop action to session {session_id} through the session update endpoint.
DELETE /sessions/{session_id} Delete an agent session and its tasks · Delete Session #
Ask an LLM
“How do I delete an agent session together with every task in it?”
“What gets removed when I delete an agent session?”
Tell an agent destructive · confirm first
Delete agent session {session_id} and all of its tasks.
Remove session {session_id} from my project entirely.
POST /sessions/{session_id}/purge Purge all stored data for a session · Purge Session #
Ask an LLM
“How do I immediately wipe screenshots, logs and files for a session on a zero-data-retention project?”
“Can I redact personal data from one session now instead of waiting for the scheduled cleanup?”
Tell an agent destructive · confirm first
Purge every stored object and redact PII for session {session_id} right now.
Run the zero-data-retention cleanup on session {session_id} with no grace period.
GET /sessions/{session_id}/public-share Get a session's public share link and stats · Get Session Public Share #
Ask an LLM
“What's the public share URL for a session I already shared?”
“How many times has my shared session link been viewed?”
Tell an agent
Show the existing public share link and usage stats for session {session_id}.
Check the view statistics on the shared replay of session {session_id}.
POST /sessions/{session_id}/public-share Create a public share link for a session · Create Session Public Share #
Ask an LLM
“How can I share a replay of an agent session with someone who doesn't have an account?”
“Can I make an agent session publicly viewable?”
Tell an agent
Create a public share link for session {session_id}.
Make session {session_id} public so I can send the link to a colleague.
DELETE /sessions/{session_id}/public-share Revoke a session's public share link · Delete Session Public Share #
Ask an LLM
“How do I stop a session from being publicly viewable?”
“Can I take down the public link I created for a session?”
Tell an agent destructive · confirm first
Remove the public share from session {session_id}.
Unshare session {session_id} so the public link stops working.
POST /sessions/{session_id}/stop Stop a session or only its running task · Stop Session #
Ask an LLM
“Can I stop just the query an agent is running while leaving the session idle and alive?”
“How do I destroy a session's sandbox entirely using the dedicated stop endpoint?”
Tell an agent destructive · confirm first
Use the stop endpoint to destroy the sandbox for session {session_id}.
Halt whatever session {session_id} is doing right now but keep it idle for my next message.
GET /sessions/{session_id}/messages Read a session's message history · List Session Messages #
Ask an LLM
“How can I read the conversation between me and the agent in a session?”
“Can I page through a session's messages before or after a given point?”
Tell an agent
Show the messages in session {session_id} after {after}.
List the last {limit} messages of session {session_id} before {before}.
POST /sessions/{session_id}/queue Send a follow-up message to a session · Queue Session Message #
Ask an LLM
“How do I give an agent a follow-up instruction while it's still busy?”
“Can a new message interrupt the agent's current run instead of waiting its turn?”
Tell an agent
Tell the agent in session {session_id}: {text}.
Interrupt session {session_id} and have it do this instead: {text} (interrupt {interrupt}).
GET /sessions/{session_id}/queue View a session's pending message queue · List Session Queue #
Ask an LLM
“Which of my follow-up messages are still waiting in a session's queue?”
“Can I see the steering handoffs and interrupt cutoffs for a session?”
Tell an agent
Show the open queued messages and steering cutoffs for session {session_id}.
List what is waiting in the queue of session {session_id}.
GET /sessions/{session_id}/queue/{message_id} Check one queued message's status · Get Session Queue Message #
Ask an LLM
“Has the follow-up message I queued been picked up by the agent yet?”
“What happened to a specific message I sent to a session's queue?”
Tell an agent
Show queued message {message_id} in session {session_id}.
Check whether message {message_id} in session {session_id} was handed off.
DELETE /sessions/{session_id}/queue/{message_id} Cancel a message still waiting in the queue · Cancel Queued Message #
Ask an LLM
“Can I take back a follow-up message before the agent starts on it?”
“Why would cancelling a queued message fail after the agent has claimed it?”
Tell an agent destructive · confirm first
Cancel queued message {message_id} in session {session_id}.
Withdraw pending message {message_id} from session {session_id} before it runs.

Documentation

📖
APIReference
https://browser-use.com/api
📖
Documentation
https://docs.browser-use.com/cloud/api-v4-overview
📖
Documentation
https://docs.browser-use.com/cloud/api-reference
📖
Documentation
https://docs.browser-use.com/cloud/api-v2-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/browser-use/refs/heads/main/openapi/browser-use-sessions-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/browser-use/refs/heads/main/data-model/browser-use-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/browser-use:browser-use-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

browser-use-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Browser Use Sessions API
  version: '1.0'
  description: 'Operations tagged Sessions across 3 of this provider''s published API definitions: browser-use-api-v2-openapi.json, browser-use-api-v3-openapi.json, browser-use-api-v4-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.browser-use.com/api/v2
  description: Production server
- url: https://api.browser-use.com/api/v3
  description: Production server
- url: https://api.browser-use.com/api/v4
  description: Production server
tags:


# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/browser-use/refs/heads/main/openapi/browser-use-sessions-api-openapi.yml