Skip to content

[Browser Run] Add REST API browser session to get-started #32085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kathayl wants to merge 1 commit into
base: production
Choose a base branch
from
+49 −1
Open

[Browser Run] Add REST API browser session to get-started #32085

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion src/content/docs/browser-run/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ products:
- browser-run
---

import { Render, Tabs, TabItem } from "~/components";
import { Render, Tabs, TabItem, CURL } from "~/components";

Cloudflare Browser Run (formerly Browser Rendering) allows you to programmatically control a headless browser, enabling you to do things like take screenshots, generate PDFs, and perform automated browser tasks. This guide will help you choose the right integration method and get you started with your first project.

Expand Down Expand Up @@ -52,6 +52,52 @@ Check out the full list of [Quick Actions endpoints](/browser-run/quick-actions/

## Browser Sessions

Browser Sessions give you full control over a headless browser. You can connect from anywhere using the REST API, or from a Cloudflare Worker using a browser binding.

<Tabs> <TabItem label="REST API">

### Prerequisites

- Sign up for a [Cloudflare account](https://dash.cloudflare.com/sign-up/workers-and-pages).
- Create a [Cloudflare API Token](/fundamentals/api/get-started/create-token/) with `Browser Rendering - Edit` permissions.

### Create a browser session

A single API call gives you a live browser session you can see and interact with:

@irvinebroque irvinebroque Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the product!


<CURL
url="https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/browser-rendering/devtools/browser"
method="POST"
headers={{
Authorization: "Bearer $CLOUDFLARE_API_TOKEN",
}}
query={{
keep_alive: "600000",
targets: "true",
}}
/>

```json title="Response" {5}
{
"sessionId": "1909cef7-23e8-4394-bc31-27404bf4348f",
"targets": [
{
"devtoolsFrontendUrl": "https://live.browser.run/ui/inspector?wss=..."
}
]
}
```

Copy the `devtoolsFrontendUrl` and open it in your browser. You now have a real browser session running on Cloudflare that you can interact with directly: enter a URL, click around, and inspect the page.

You can drive browser sessions programmatically using [CDP](/browser-run/cdp/), [Puppeteer](/browser-run/cdp/puppeteer/), or [Playwright](/browser-run/cdp/playwright/) from any environment. Browser sessions also support:

- **[Live View](/browser-run/features/live-view/)**: See and interact with a remote session in real time, useful for debugging automation scripts or monitoring browser activity.
- **[Session Recording](/browser-run/features/session-recording/)**: Record browser sessions for playback, so you can review what happened during an automation run.
- **[Human in the Loop](/browser-run/features/human-in-the-loop/)**: Pause automation and hand control to a human for tasks that require manual intervention, like solving CAPTCHAs or completing login flows.

</TabItem> <TabItem label="Workers binding">

### Prerequisites

<Render file="prereqs" product="workers" />
Expand All @@ -63,6 +109,8 @@ Check out the full list of [Quick Actions endpoints](/browser-run/quick-actions/
product="browser-run"
/>

</TabItem> </Tabs>

## Next steps

- Check out all the [Quick Actions endpoints](/browser-run/quick-actions/)
Expand Down