--- title: Browser Rendering --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Browser Rendering #### Browser RenderingContent ##### [Get HTML content.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/content/methods/create) client.browserRendering.content.create(ContentCreateParamsparams, RequestOptionsoptions?): [ContentCreateResponse]() POST/accounts/{account\_id}/browser-rendering/content ##### ModelsExpand Collapse ContentCreateResponse = string HTML content. [Link to this property](<#(resource)%20browser_rendering.content%20%3E%20(model)%20content_create_response%20%3E%20(schema)>) #### Browser RenderingPDF ##### [Get PDF.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/pdf/methods/create) client.browserRendering.pdf.create(PDFCreateParamsparams, RequestOptionsoptions?): Response POST/accounts/{account\_id}/browser-rendering/pdf #### Browser RenderingScrape ##### [Scrape elements.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/scrape/methods/create) 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. Link to this property value: string Attribute value. Link to this property

Link to this property height: number Element height. Link to this property html: string HTML content. Link to this property left: number Element left. Link to this property text: string Text content. Link to this property top: number Element top. Link to this property width: number Element width. Link to this property

Link to this property selector: string Selector. Link to this property

[Link to this property](<#(resource)%20browser_rendering.scrape%20%3E%20(model)%20scrape_create_response%20%3E%20(schema)>) #### Browser RenderingScreenshot ##### [Get screenshot.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/screenshot/methods/create) 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. Link to this property

errors?: Array<Error>

code: number Error code. Link to this property message: string Error message. Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.screenshot%20%3E%20(model)%20screenshot_create_response%20%3E%20(schema)>) #### Browser RenderingSnapshot ##### [Get HTML content and screenshot.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/snapshot/methods/create) client.browserRendering.snapshot.create(SnapshotCreateParamsparams, RequestOptionsoptions?): [SnapshotCreateResponse]() {accessibilityTree, content, markdown, screenshot } POST/accounts/{account\_id}/browser-rendering/snapshot ##### ModelsExpand Collapse

SnapshotCreateResponse {accessibilityTree, content, markdown, screenshot }

accessibilityTree?: AccessibilityTree {role, autocomplete, checked, 23 more } Accessibility tree node

role: string Link to this property autocomplete?: string Link to this property

checked?: boolean| "mixed"

One of the following: boolean Link to this property

"mixed"

"mixed" Link to this property

Link to this property

Link to this property children?: Array<unknown> Link to this property description?: string Link to this property disabled?: boolean Link to this property expanded?: boolean Link to this property focused?: boolean Link to this property haspopup?: string Link to this property invalid?: string Link to this property keyshortcuts?: string Link to this property level?: number Link to this property modal?: boolean Link to this property multiline?: boolean Link to this property multiselectable?: boolean Link to this property name?: string Link to this property orientation?: string Link to this property

pressed?: boolean| "mixed"

One of the following: boolean Link to this property

"mixed"

"mixed" Link to this property

Link to this property

Link to this property readonly?: boolean Link to this property required?: boolean Link to this property roledescription?: string Link to this property selected?: boolean Link to this property

value?: string| number

One of the following: string Link to this property number Link to this property

Link to this property valuemax?: number Link to this property valuemin?: number Link to this property valuetext?: string Link to this property

Link to this property content?: string HTML content. Link to this property markdown?: string Markdown content. Prefixed with YAML frontmatter (e.g. title) when the page provides that metadata. Link to this property screenshot?: string Base64 encoded image. Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(model)%20snapshot_create_response%20%3E%20(schema)>) #### Browser RenderingJson ##### [Get json.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/json/methods/create) client.browserRendering.json.create(JsonCreateParamsparams, RequestOptionsoptions?): [JsonCreateResponse]() POST/accounts/{account\_id}/browser-rendering/json ##### ModelsExpand Collapse JsonCreateResponse = Record [Link to this property](<#(resource)%20browser_rendering.json%20%3E%20(model)%20json_create_response%20%3E%20(schema)>) #### Browser RenderingLinks ##### [Get Links.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/links/methods/create) client.browserRendering.links.create(LinkCreateParamsparams, RequestOptionsoptions?): [LinkCreateResponse]() POST/accounts/{account\_id}/browser-rendering/links ##### ModelsExpand Collapse LinkCreateResponse = Array [Link to this property](<#(resource)%20browser_rendering.links%20%3E%20(model)%20link_create_response%20%3E%20(schema)>) #### Browser RenderingMarkdown ##### [Get markdown.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/markdown/methods/create) client.browserRendering.markdown.create(MarkdownCreateParamsparams, RequestOptionsoptions?): [MarkdownCreateResponse]() POST/accounts/{account\_id}/browser-rendering/markdown ##### ModelsExpand Collapse MarkdownCreateResponse = string Markdown content. Prefixed with YAML frontmatter (e.g. `title`) when the page provides that metadata. [Link to this property](<#(resource)%20browser_rendering.markdown%20%3E%20(model)%20markdown_create_response%20%3E%20(schema)>) #### Browser RenderingAccessibility Tree ##### [Get accessibility tree page](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/accessibility_tree/methods/create) client.browserRendering.accessibilityTree.create(AccessibilityTreeCreateParamsparams, RequestOptionsoptions?): [AccessibilityTreeCreateResponse]() {accessibilityTree } POST/accounts/{account\_id}/browser-rendering/accessibilityTree ##### ModelsExpand Collapse

AccessibilityTreeCreateResponse {accessibilityTree }

accessibilityTree: AccessibilityTree| null Accessibility tree node

role: string Link to this property autocomplete?: string Link to this property

checked?: boolean| "mixed"

One of the following: boolean Link to this property

"mixed"

"mixed" Link to this property

Link to this property

pressed?: boolean| "mixed"

One of the following: boolean Link to this property

"mixed"

"mixed" Link to this property

Link to this property

Link to this property readonly?: boolean Link to this property required?: boolean Link to this property roledescription?: string Link to this property selected?: boolean Link to this property

value?: string| number

One of the following: string Link to this property number Link to this property

Link to this property valuemax?: number Link to this property valuemin?: number Link to this property valuetext?: string Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.accessibility_tree%20%3E%20(model)%20accessibility_tree_create_response%20%3E%20(schema)>) #### Browser RenderingCrawl ##### [Crawl websites.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/create) client.browserRendering.crawl.create(CrawlCreateParamsparams, RequestOptionsoptions?): [CrawlCreateResponse]() POST/accounts/{account\_id}/browser-rendering/crawl ##### [Get crawl result.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/get) 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.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/crawl/methods/delete) 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. [Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_create_response%20%3E%20(schema)>)

CrawlGetResponse {id, browserSecondsUsed, finished, 5 more }

id: string Crawl job ID. Link to this property browserSecondsUsed: number Total seconds spent in browser so far. Link to this property finished: number Total number of URLs that have been crawled so far. Link to this property

records: Array<Record> List of crawl job records.

status: "queued"| "errored"| "completed"| 3 more Current status of the crawled URL.

One of the following: "queued" Link to this property "errored" Link to this property "completed" Link to this property "disallowed" Link to this property "skipped" Link to this property "cancelled" Link to this property

Link to this property url: string Crawled URL. Link to this property html?: string HTML content of the crawled URL. Link to this property json?: Record<string, unknown> JSON of the content of the crawled URL. Link to this property markdown?: string Markdown of the content of the crawled URL. Link to this property

metadata?: Metadata {status, url, title } Absent for urls that never reached a fetch.

status: number HTTP status code of the crawled page. Link to this property url: string Final URL of the crawled page. Link to this property title?: string Title of the crawled page. Link to this property

Link to this property

Link to this property 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. Link to this property status: string Current crawl job status. Link to this property total: number Total current number of URLs in the crawl job. Link to this property cursor?: string Cursor for pagination. Link to this property

[Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_get_response%20%3E%20(schema)>)

CrawlDeleteResponse {job\_id, message }

job\_id: string The ID of the cancelled job. Link to this property message: string Cancellation confirmation message. Link to this property

[Link to this property](<#(resource)%20browser_rendering.crawl%20%3E%20(model)%20crawl_delete_response%20%3E%20(schema)>) #### Browser RenderingDevtools #### Browser RenderingDevtoolsSession ##### [List sessions.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/session/methods/list) client.browserRendering.devtools.session.list(SessionListParams {account\_id, limit, offset } params, RequestOptionsoptions?): [SessionListResponse]() {sessionId, closeReason, closeReasonText, 8 more } GET/accounts/{account\_id}/browser-rendering/devtools/session ##### [Get session details.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/session/methods/get) client.browserRendering.devtools.session.get(stringsessionID, SessionGetParams {account\_id } params, RequestOptionsoptions?): [SessionGetResponse]() {sessionId, closeReason, closeReasonText, 8 more } | null GET/accounts/{account\_id}/browser-rendering/devtools/session/{session\_id} ##### ModelsExpand Collapse

SessionListResponse = Array<SessionListResponseItem>

sessionId: string Session ID. formatuuid Link to this property closeReason?: number Reason code for session closure. Link to this property closeReasonText?: string Human-readable close reason. Link to this property connectionEndTime?: number Connection end time. Link to this property connectionId?: string Connection ID. Link to this property connectionStartTime?: number Connection start time. Link to this property devtoolsFrontendUrl?: string DevTools frontend URL. Link to this property endTime?: number Session end time. Link to this property lastUpdated?: number Last updated timestamp. Link to this property startTime?: number Session start time. Link to this property webSocketDebuggerUrl?: string WebSocket URL for debugging this target. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.session%20%3E%20(model)%20session_list_response%20%3E%20(schema)>)

SessionGetResponse {sessionId, closeReason, closeReasonText, 8 more }

[Link to this property](<#(resource)%20browser_rendering.devtools.session%20%3E%20(model)%20session_get_response%20%3E%20(schema)>) #### Browser RenderingDevtoolsBrowser ##### [Get a browser session ID.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/methods/create) client.browserRendering.devtools.browser.create(BrowserCreateParams {account\_id, keep\_alive, lab, 4 more } params, RequestOptionsoptions?): [BrowserCreateResponse]() {sessionId, webSocketDebuggerUrl } POST/accounts/{account\_id}/browser-rendering/devtools/browser ##### [Close browser session.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/methods/delete) client.browserRendering.devtools.browser.delete(stringsessionID, BrowserDeleteParams {account\_id } params, RequestOptionsoptions?): [BrowserDeleteResponse]() {status } DELETE/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id} ##### [Get browser version metadata.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/methods/version) client.browserRendering.devtools.browser.version(stringsessionID, BrowserVersionParams {account\_id } params, RequestOptionsoptions?): [BrowserVersionResponse]() {Browser, Protocol-Version, User-Agent, 3 more } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/version ##### [Get Chrome DevTools Protocol schema.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/methods/protocol) client.browserRendering.devtools.browser.protocol(stringsessionID, BrowserProtocolParams {account\_id } params, RequestOptionsoptions?): [BrowserProtocolResponse]() {domains, version } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/protocol ##### ModelsExpand Collapse

BrowserCreateResponse {sessionId, webSocketDebuggerUrl }

sessionId: string Browser session ID. Link to this property webSocketDebuggerUrl?: string WebSocket URL for the session. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser%20%3E%20(model)%20browser_create_response%20%3E%20(schema)>)

BrowserDeleteResponse {status }

status: "closing"| "closed"

One of the following: "closing" Link to this property "closed" Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser%20%3E%20(model)%20browser_delete_response%20%3E%20(schema)>)

BrowserVersionResponse {Browser, Protocol-Version, User-Agent, 3 more }

Browser: string Browser name and version. Link to this property "Protocol-Version": string Chrome DevTools Protocol version. Link to this property "User-Agent": string User agent string. Link to this property "V8-Version": string V8 JavaScript engine version. Link to this property "WebKit-Version": string WebKit version. Link to this property webSocketDebuggerUrl: string WebSocket URL for debugging the browser. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser%20%3E%20(model)%20browser_version_response%20%3E%20(schema)>)

BrowserProtocolResponse {domains, version }

domains: Array<Domain> List of protocol domains.

domain: string Domain name. Link to this property commands?: Array<Record<string, unknown>> Available commands. Link to this property dependencies?: Array<string> Domain dependencies. Link to this property events?: Array<Record<string, unknown>> Available events. Link to this property experimental?: boolean Whether this domain is experimental. Link to this property types?: Array<Record<string, unknown>> Type definitions. Link to this property

Link to this property

version?: Version {major, minor } Protocol version.

major: string Major version. Link to this property minor: string Minor version. Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser%20%3E%20(model)%20browser_protocol_response%20%3E%20(schema)>) #### Browser RenderingDevtoolsBrowserLive View ##### [Mint live view URLs for a browser session](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/live_view/methods/create) client.browserRendering.devtools.browser.liveView.create(stringsessionID, LiveViewCreateParams {account\_id, expiresInMs, guardrails, 2 more } params, RequestOptionsoptions?): [LiveViewCreateResponse]() {id, devtoolsFrontendUrl, options, webSocketDebuggerUrl } POST/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/live\_view ##### ModelsExpand Collapse

LiveViewCreateResponse {id, devtoolsFrontendUrl, options, webSocketDebuggerUrl }

id: string Target ID Link to this property devtoolsFrontendUrl: string URL to open the live view in a browser formaturi Link to this property

options: Options {mode, guardrails }

mode: "devtools"| "tab"| "full" UI mode for the live view

One of the following: "devtools" Link to this property "tab" Link to this property "full" Link to this property

Link to this property

guardrails?: Guardrails {mode } Connection guardrails applied to this link

mode: "readonly" Link to this property

Link to this property

Link to this property webSocketDebuggerUrl: string WebSocket URL for CDP connection formaturi Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.live_view%20%3E%20(model)%20live_view_create_response%20%3E%20(schema)>) #### Browser RenderingDevtoolsBrowserPage #### Browser RenderingDevtoolsBrowserTargets ##### [Open a new browser tab.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/create) client.browserRendering.devtools.browser.targets.create(stringsessionID, TargetCreateParams {account\_id, liveViewUrlExpiresInMs, url } params, RequestOptionsoptions?): [TargetCreateResponse]() {id, type, url, 4 more } PUT/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/new ##### [List targets.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/list) client.browserRendering.devtools.browser.targets.list(stringsessionID, TargetListParams {account\_id, liveViewUrlExpiresInMs } params, RequestOptionsoptions?): [TargetListResponse]() {id, type, url, 4 more } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/list ##### [Get a target by ID.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/get) client.browserRendering.devtools.browser.targets.get(stringtargetID, TargetGetParams {account\_id, session\_id } params, RequestOptionsoptions?): [TargetGetResponse]() {id, type, url, 4 more } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/list/{target\_id} ##### [Activate a browser target.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/activate) client.browserRendering.devtools.browser.targets.activate(stringtargetID, TargetActivateParams {account\_id, session\_id } params, RequestOptionsoptions?): [TargetActivateResponse]() {message } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/activate/{target\_id} ##### [Close a browser target.](https://developers.cloudflare.com/api/typescript/resources/browser_rendering/subresources/devtools/subresources/browser/subresources/targets/methods/close) client.browserRendering.devtools.browser.targets.close(stringtargetID, TargetCloseParams {account\_id, session\_id } params, RequestOptionsoptions?): [TargetCloseResponse]() {message } GET/accounts/{account\_id}/browser-rendering/devtools/browser/{session\_id}/json/close/{target\_id} ##### ModelsExpand Collapse

TargetCreateResponse {id, type, url, 4 more }

id: string Target ID. Link to this property type: string Target type (page, background\_page, worker, etc.). Link to this property url: string URL of the target. Link to this property description?: string Target description. Link to this property devtoolsFrontendUrl?: string DevTools frontend URL. Link to this property title?: string Title of the target. Link to this property webSocketDebuggerUrl?: string WebSocket URL for debugging this target. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.targets%20%3E%20(model)%20target_create_response%20%3E%20(schema)>)

TargetListResponse = Array<TargetListResponseItem>

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.targets%20%3E%20(model)%20target_list_response%20%3E%20(schema)>)

TargetGetResponse {id, type, url, 4 more }

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.targets%20%3E%20(model)%20target_get_response%20%3E%20(schema)>)

TargetActivateResponse {message }

message: string Target activated. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.targets%20%3E%20(model)%20target_activate_response%20%3E%20(schema)>)

TargetCloseResponse {message }

message: string Target is closing. Link to this property

[Link to this property](<#(resource)%20browser_rendering.devtools.browser.targets%20%3E%20(model)%20target_close_response%20%3E%20(schema)>)