Skip to content
Cloudflare API
Start here
API Reference

Browser Rendering

Browser RenderingContent

Get HTML content.
browser_rendering.content.create(ContentCreateParams**kwargs) -> ContentCreateResponse
POST/accounts/{account_id}/browser-rendering/content
ModelsExpand Collapse
str

HTML content.

Browser RenderingPDF

Get PDF.
browser_rendering.pdf.create(PDFCreateParams**kwargs) -> BinaryResponseContent
POST/accounts/{account_id}/browser-rendering/pdf

Browser RenderingScrape

Scrape elements.
browser_rendering.scrape.create(ScrapeCreateParams**kwargs) -> ScrapeCreateResponse
POST/accounts/{account_id}/browser-rendering/scrape
ModelsExpand Collapse
List[ScrapeCreateResponseItem]
results: ScrapeCreateResponseItemResults
attributes: List[ScrapeCreateResponseItemResultsAttribute]
name: str

Attribute name.

value: str

Attribute value.

height: float

Element height.

html: str

HTML content.

left: float

Element left.

text: str

Text content.

top: float

Element top.

width: float

Element width.

selector: str

Selector.

Browser RenderingScreenshot

Get screenshot.
browser_rendering.screenshot.create(ScreenshotCreateParams**kwargs) -> ScreenshotCreateResponse
POST/accounts/{account_id}/browser-rendering/screenshot
ModelsExpand Collapse
class ScreenshotCreateResponse: …
success: bool

Response status.

errors: Optional[List[Error]]
code: float

Error code.

message: str

Error message.

Browser RenderingSnapshot

Get HTML content and screenshot.
browser_rendering.snapshot.create(SnapshotCreateParams**kwargs) -> SnapshotCreateResponse
POST/accounts/{account_id}/browser-rendering/snapshot
ModelsExpand Collapse
class SnapshotCreateResponse: …
content: str

HTML content.

screenshot: str

Base64 encoded image.

Browser RenderingJson

Get json.
browser_rendering.json.create(JsonCreateParams**kwargs) -> JsonCreateResponse
POST/accounts/{account_id}/browser-rendering/json
ModelsExpand Collapse
Dict[str, Optional[object]]
Get Links.
browser_rendering.links.create(LinkCreateParams**kwargs) -> LinkCreateResponse
POST/accounts/{account_id}/browser-rendering/links
ModelsExpand Collapse

Browser RenderingMarkdown

Get markdown.
browser_rendering.markdown.create(MarkdownCreateParams**kwargs) -> MarkdownCreateResponse
POST/accounts/{account_id}/browser-rendering/markdown
ModelsExpand Collapse
str

Markdown content.

Browser RenderingCrawl

Crawl websites.
browser_rendering.crawl.create(CrawlCreateParams**kwargs) -> CrawlCreateResponse
POST/accounts/{account_id}/browser-rendering/crawl
Get crawl result.
browser_rendering.crawl.get(strjob_id, CrawlGetParams**kwargs) -> CrawlGetResponse
GET/accounts/{account_id}/browser-rendering/crawl/{job_id}
Cancel a crawl job.
browser_rendering.crawl.delete(strjob_id, CrawlDeleteParams**kwargs) -> CrawlDeleteResponse
DELETE/accounts/{account_id}/browser-rendering/crawl/{job_id}
ModelsExpand Collapse
str

Crawl job ID.

class CrawlGetResponse: …
id: str

Crawl job ID.

browser_seconds_used: float

Total seconds spent in browser so far.

finished: float

Total number of URLs that have been crawled so far.

records: List[Record]

List of crawl job records.

metadata: RecordMetadata
status: float

HTTP status code of the crawled page.

url: str

Final URL of the crawled page.

title: Optional[str]

Title of the crawled page.

status: Literal["queued", "errored", "completed", 3 more]

Current status of the crawled URL.

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

Crawled URL.

html: Optional[str]

HTML content of the crawled URL.

json: Optional[Dict[str, Optional[object]]]

JSON of the content of the crawled URL.

markdown: Optional[str]

Markdown of the content of the crawled URL.

skipped: float

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: str

Current crawl job status.

total: float

Total current number of URLs in the crawl job.

cursor: Optional[str]

Cursor for pagination.

class CrawlDeleteResponse: …
job_id: str

The ID of the cancelled job.

message: str

Cancellation confirmation message.