Skip to content
Cloudflare API
Start here
API Reference

Browser Rendering

Browser RenderingContent

Get HTML content.
client.browserRendering.content.create(ContentCreateParamsparams, RequestOptionsoptions?): ContentCreateResponse
POST/accounts/{account_id}/browser-rendering/content
ModelsExpand Collapse
ContentCreateResponse = string

HTML content.

Browser RenderingPDF

Get PDF.
client.browserRendering.pdf.create(PDFCreateParamsparams, RequestOptionsoptions?): Response
POST/accounts/{account_id}/browser-rendering/pdf

Browser RenderingScrape

Scrape elements.
client.browserRendering.scrape.create(ScrapeCreateParamsparams, RequestOptionsoptions?): ScrapeCreateResponse { results, selector }
POST/accounts/{account_id}/browser-rendering/scrape
ModelsExpand Collapse
ScrapeCreateResponse = Array<ScrapeCreateResponseItem>
results: Results { attributes, height, html, 4 more }
attributes: Array<Attribute>
name: string

Attribute name.

value: string

Attribute value.

height: number

Element height.

html: string

HTML content.

left: number

Element left.

text: string

Text content.

top: number

Element top.

width: number

Element width.

selector: string

Selector.

Browser RenderingScreenshot

Get screenshot.
client.browserRendering.screenshot.create(ScreenshotCreateParamsparams, RequestOptionsoptions?): ScreenshotCreateResponse { success, errors }
POST/accounts/{account_id}/browser-rendering/screenshot
ModelsExpand Collapse
ScreenshotCreateResponse { success, errors }
success: boolean

Response status.

errors?: Array<Error>
code: number

Error code.

message: string

Error message.

Browser RenderingSnapshot

Get HTML content and screenshot.
client.browserRendering.snapshot.create(SnapshotCreateParamsparams, RequestOptionsoptions?): SnapshotCreateResponse { content, screenshot }
POST/accounts/{account_id}/browser-rendering/snapshot
ModelsExpand Collapse
SnapshotCreateResponse { content, screenshot }
content: string

HTML content.

screenshot: string

Base64 encoded image.

Browser RenderingJson

Get json.
client.browserRendering.json.create(JsonCreateParamsparams, RequestOptionsoptions?): JsonCreateResponse
POST/accounts/{account_id}/browser-rendering/json
ModelsExpand Collapse
JsonCreateResponse = Record<string, unknown>
Get Links.
client.browserRendering.links.create(LinkCreateParamsparams, RequestOptionsoptions?): LinkCreateResponse
POST/accounts/{account_id}/browser-rendering/links
ModelsExpand Collapse

Browser RenderingMarkdown

Get markdown.
client.browserRendering.markdown.create(MarkdownCreateParamsparams, RequestOptionsoptions?): MarkdownCreateResponse
POST/accounts/{account_id}/browser-rendering/markdown
ModelsExpand Collapse
MarkdownCreateResponse = string

Markdown content.

Browser RenderingCrawl

Crawl websites.
client.browserRendering.crawl.create(CrawlCreateParamsparams, RequestOptionsoptions?): CrawlCreateResponse
POST/accounts/{account_id}/browser-rendering/crawl
Get crawl result.
client.browserRendering.crawl.get(stringjobId, CrawlGetParams { account_id, cacheTTL, cursor, 2 more } params, RequestOptionsoptions?): CrawlGetResponse { id, browserSecondsUsed, finished, 5 more }
GET/accounts/{account_id}/browser-rendering/crawl/{job_id}
Cancel a crawl job.
client.browserRendering.crawl.delete(stringjobId, CrawlDeleteParams { account_id } params, RequestOptionsoptions?): CrawlDeleteResponse { job_id, message }
DELETE/accounts/{account_id}/browser-rendering/crawl/{job_id}
ModelsExpand Collapse
CrawlCreateResponse = string

Crawl job ID.

CrawlGetResponse { id, browserSecondsUsed, finished, 5 more }
id: string

Crawl job ID.

browserSecondsUsed: number

Total seconds spent in browser so far.

finished: number

Total number of URLs that have been crawled so far.

records: Array<Record>

List of crawl job records.

metadata: Metadata { status, url, title }
status: number

HTTP status code of the crawled page.

url: string

Final URL of the crawled page.

title?: string

Title of the crawled page.

status: "queued" | "errored" | "completed" | 3 more

Current status of the crawled URL.

One of the following:
"queued"
"errored"
"completed"
"disallowed"
"skipped"
"cancelled"
url: string

Crawled URL.

html?: string

HTML content of the crawled URL.

json?: Record<string, unknown>

JSON of the content of the crawled URL.

markdown?: string

Markdown of the content of the crawled URL.

skipped: number

Total number of URLs that were skipped due to include/exclude/subdomain filters. Skipped URLs are included in records but are not counted toward total/finished.

status: string

Current crawl job status.

total: number

Total current number of URLs in the crawl job.

cursor?: string

Cursor for pagination.

CrawlDeleteResponse { job_id, message }
job_id: string

The ID of the cancelled job.

message: string

Cancellation confirmation message.