Browser Use

Archive a workspace so it is no longer readable through the workspace API. The operation is idempotent for missing, already archived, and foreign workspace IDs.

Cancel a queued session message while it is still pending. Messages already claimed for dispatch cannot be cancelled.

Idempotently cancel an in-flight browser-agent run; completed work cannot be resumed by this call.

Launch a paid managed browser for direct CDP control; time is prepaid and unused time is refunded when the browser is stopped.

Create a persistent browser profile for reusable cookies and browser state.

Create an empty workspace for browser-run input files and outputs.

Permanently delete a persistent browser profile and its configuration.

Soft-delete a conversation session and cancel its active run and pending messages. The session can no longer be opened or continued, while runs, events, and usage records remain available for billing and analytics.

Permanently delete one exact relative file path from a workspace.

Disconnect a downstream provider from the Browser Use project, revoking its availability to future runs.

Get a managed browser's status, control URLs, costs, metadata, and recording state.

Check whether one downstream integration provider is connected to the Browser Use project.

Get one persistent browser profile's metadata and observed cookie domains.

Get one queued session message, including its terminal handoff state.

Get a run's full result, usage, and optionally its ordered input-file attachments.

Read a run's lightweight indexed status for caller-controlled polling. Poll until the status is completed, failed, or cancelled, then fetch the full run once for its result and usage.

Get one conversation session's latest-run summary and busy or idle status.

Get all feedback votes recorded for a conversation session.

Get a session's current or inactive public share-link state without changing its exposure.

Get workspace metadata and optionally its current storage use and plan quota.

List one page of files downloaded by a managed browser, optionally including presigned URLs that expire after 15 minutes.

List managed browser sessions with status, metadata, and agent-session filters, one page at a time.

List the category names used to organize Browser Use integration providers.

Search Browser Use integration providers and filter by popularity or project connection status, one page at a time.

Return AgentCard wallets and the project's active Stripe Link connection that browser runs can use for payments.

List or search persistent browser profiles one page at a time.

Read one page of a run's execution events incrementally, with optional event output payloads.

List browser-agent runs, optionally restricted to one conversation session, one page at a time.

List pending and recently delivered messages for a conversation session, including transcript cutoffs created by steering interrupts.

List conversation sessions with each session's latest run and busy or idle status, one page at a time.

List one page of files in a workspace by path prefix, optionally including temporary download URLs.

Queue a follow-up for a conversation session, optionally interrupting its active run; dispatch may consume credits and trigger external browser work.

Set, replace, or clear feedback for one session chat item.

Enable or disable a session's stable public share link, creating or reactivating it when enabled.

Start an asynchronous hosted browser-agent task that may make irreversible changes on external sites and consume project credits.

Stop a managed browser session and refund unused prepaid time subject to the one-minute minimum charge.

Update a persistent browser profile's name, user identifier, or both.

Rename a conversation session or explicitly clear its title.

Rename a workspace or explicitly clear its name.