Cloudflare Browser Run Crawl
Cloudflare Browser Run Crawl provides an authenticated REST crawl API that follows links from a starting URL and returns HTML, Markdown, or JSON records. Crawl jobs are asynchronous and can be polled, paginated, or cancelled.
Connect this API to an AI agent Browse all specs
What you can do with Cloudflare Browser Run Crawl via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| POST | /accounts/{account_id}/browser-rendering/crawl |
postAccountsByAccountIdBrowserRenderingCrawl | Start a website crawl Method: POST Path: /accounts/{account_id}/browser-rendering/crawl IMPORTANT: This function has 2 REQUIRED parameter(s) and 6 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - account_id: Cloudflare account identifier with Browser Rendering enabled. Request Body: REQUIRED: - url: Starting URL. OPTIONAL: - limit: limit parameter from application/json - depth: depth parameter from application/json - source: source parameter from application/json - formats: formats array - render: render parameter from application/json - maxAge: maxAge parameter from application/json |
| GET | /accounts/{account_id}/browser-rendering/crawl/{job_id} |
getAccountsByAccountIdBrowserRenderingCrawlByJobId | Get crawl status or results Method: GET Path: /accounts/{account_id}/browser-rendering/crawl/{job_id} IMPORTANT: This function has 2 REQUIRED parameter(s) and 3 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - account_id: Cloudflare account identifier with Browser Rendering enabled. - job_id: Crawl job identifier returned by the create operation. Query Parameters: OPTIONAL: - cursor: Pagination cursor for large result sets. - limit: Maximum records to return. - status: Filter records by crawl status. |
| DELETE | /accounts/{account_id}/browser-rendering/crawl/{job_id} |
deleteAccountsByAccountIdBrowserRenderingCrawlByJobId | Cancel a crawl job Method: DELETE Path: /accounts/{account_id}/browser-rendering/crawl/{job_id} IMPORTANT: This function has 2 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - account_id: Cloudflare account identifier with Browser Rendering enabled. - job_id: Crawl job identifier. |
Usage guide
## Authentication Create a scoped Cloudflare API token with the **Browser Rendering - Edit** permission for the target account. Send it as `Authorization: Bearer <CLOUDFLARE_API_TOKEN>`. Supply the account ID in the URL path. Keep both the account ID and token server-side. ## Operations - `POST /accounts/{account_id}/browser-rendering/crawl` starts an asynchronous crawl and returns a job ID. - `GET /accounts/{account_id}/browser-rendering/crawl/{job_id}` polls status and retrieves records; use `formats: ["markdown"]` for Markdown output. - `DELETE /accounts/{account_id}/browser-rendering/crawl/{job_id}` cancels a running job. ## Example ```bash curl -X POST "https://api.cloudflare.com/client/v4/accounts/$CLOUDFLARE_ACCOUNT_ID/browser-rendering/crawl" \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"url":"https://example.com","limit":10,"depth":1,"formats":["markdown"]}' ``` Official documentation: https://developers.cloudflare.com/browser-run/quick-actions/crawl-endpoint/
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “Cloudflare Browser Run Crawl” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.