Notes for Agents

Use the v3 REST API your instance serves to create browser-agent sessions, preserve authenticated profiles and retrieve structured results.

OpenBrowse is self-hosted. Your application calls the address of the instance you operate, authenticates with its API key and receives data directly from that instance. Existing browser-use-sdk v3 clients can move across by setting their base URL and API key. The public documentation is generated from the runtime’s OpenAPI schema, keeping endpoint descriptions tied to the surface the application actually serves. The first-party CLI is published on PyPI as openbrowse.

The integration surface

Sessions

Create a task, inspect its status, retrieve messages, stop it or remove it after use.

API reference

Profiles

Persist cookies and browser storage between runs. Treat each profile as an active credential.

Profiles guide

Operations

Read error classes, cost limits and live run state instead of guessing whether a task completed.

Error handling

OpenAPI

Read the machine-readable OpenAPI description published by this website.

OpenAPI document

Documentation MCP

Give an MCP client read-only access to this website’s documentation and OpenAPI material.

MCP endpoint

Start with the documented contract

Read authentication before putting an instance behind an application, then use the published OpenAPI description and v3 API reference for request and response details. If you are evaluating an MCP-based workflow, use this site’s documentation-only MCP endpoint and read the MCP note first: the REST API is the runtime integration contract documented by this project.