--- title: Get HTML content and screenshot. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Browser Rendering](https://developers.cloudflare.com/api/python/resources/browser_rendering) [Snapshot](https://developers.cloudflare.com/api/python/resources/browser_rendering/subresources/snapshot) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get HTML content and screenshot. browser\_rendering.snapshot.create(SnapshotCreateParams\*\*kwargs) -> [SnapshotCreateResponse]() POST/accounts/{account\_id}/browser-rendering/snapshot Returns the page’s HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Browser Rendering Write` ##### ParametersExpand Collapse account\_id: str Account ID. [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>) url: str [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20url%20%3E%20(schema)>) browser: Optional\[Literal\["kitesurf"]] Rendering backend. Set to `kitesurf` to use Kitesurf (beta). [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20browser%20%3E%20(schema)>) cache\_ttl: Optional\[float] Cache TTL default is 5s. Set to 0 to disable. maximum86400 minimum0 [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20cacheTTL%20%3E%20(schema)>) action\_timeout: Optional\[float] The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error. maximum120000 [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20actionTimeout%20%3E%20(schema)>)

add\_script\_tag: Optional\[Iterable\[Variant0AddScriptTag]] Adds a script element into the page with the desired URL or content.

id: Optional\[str] Link to this property content: Optional\[str] Link to this property type: Optional\[str] Link to this property url: Optional\[str] formaturi Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20addScriptTag%20%3E%20(schema)>)

add\_style\_tag: Optional\[Iterable\[Variant0AddStyleTag]] Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content.

content: Optional\[str] Link to this property url: Optional\[str] formaturi Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20addStyleTag%20%3E%20(schema)>) allow\_request\_pattern: Optional\[Sequence\[str]] Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first. [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20allowRequestPattern%20%3E%20(schema)>)

allow\_resource\_types: Optional\[List\[Literal\["document", "stylesheet", "image", 15 more]]] Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first.

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20allowResourceTypes%20%3E%20(schema)>)

authenticate: Optional\[Variant0Authenticate] Provide credentials for HTTP authentication.

password: str minLength1 Link to this property username: str minLength1 Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20authenticate%20%3E%20(schema)>) best\_attempt: Optional\[[bool]()] Attempt to proceed when ‘awaited’ events fail or timeout. [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20bestAttempt%20%3E%20(schema)>)

cookies: Optional\[Iterable\[Variant0Cookie]] Check options.

name: str Cookie name. Link to this property value: str Link to this property domain: Optional\[str] Link to this property expires: Optional\[float] Link to this property http\_only: Optional\[bool] Link to this property partition\_key: Optional\[str] Link to this property path: Optional\[str] Link to this property

priority: Optional\[Literal\["Low", "Medium", "High"]]

One of the following: "Low" Link to this property "Medium" Link to this property "High" Link to this property

Link to this property same\_party: Optional\[bool] Link to this property

same\_site: Optional\[Literal\["Strict", "Lax", "None"]]

One of the following: "Strict" Link to this property "Lax" Link to this property "None" Link to this property

Link to this property secure: Optional\[bool] Link to this property source\_port: Optional\[float] Link to this property

source\_scheme: Optional\[Literal\["Unset", "NonSecure", "Secure"]]

One of the following: "Unset" Link to this property "NonSecure" Link to this property "Secure" Link to this property

Link to this property url: Optional\[str] Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20cookies%20%3E%20(schema)>) emulate\_media\_type: Optional\[str] [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20emulateMediaType%20%3E%20(schema)>)

formats: Optional\[List\[Literal\["content", "screenshot", "markdown", "accessibilityTree"]]]

One of the following: "content" Link to this property "screenshot" Link to this property "markdown" Link to this property "accessibilityTree" Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20formats%20%3E%20(schema)>)

goto\_options: Optional\[Variant0GotoOptions] Check options.

referer: Optional\[str] Link to this property referrer\_policy: Optional\[str] Link to this property timeout: Optional\[float] maximum60000 Link to this property

wait\_until: Optional\[Union\[Literal\["load", "domcontentloaded", "networkidle0", "networkidle2"], List\[Literal\["load", "domcontentloaded", "networkidle0", "networkidle2"]]]]

One of the following:

Literal\["load", "domcontentloaded", "networkidle0", "networkidle2"]

One of the following: "load" Link to this property "domcontentloaded" Link to this property "networkidle0" Link to this property "networkidle2" Link to this property

Link to this property

List\[Literal\["load", "domcontentloaded", "networkidle0", "networkidle2"]]

One of the following: "load" Link to this property "domcontentloaded" Link to this property "networkidle0" Link to this property "networkidle2" Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20gotoOptions%20%3E%20(schema)>) html: Optional\[str] [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20html%20%3E%20(schema)>) reject\_request\_pattern: Optional\[Sequence\[str]] Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’. [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20rejectRequestPattern%20%3E%20(schema)>)

reject\_resource\_types: Optional\[List\[Literal\["document", "stylesheet", "image", 15 more]]] Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20rejectResourceTypes%20%3E%20(schema)>)

screenshot\_options: Optional\[Variant0ScreenshotOptions]

capture\_beyond\_viewport: Optional\[bool] Link to this property

clip: Optional\[Variant0ScreenshotOptionsClip]

height: float Link to this property width: float Link to this property x: float Link to this property y: float Link to this property scale: Optional\[float] Link to this property

Link to this property from\_surface: Optional\[bool] Link to this property full\_page: Optional\[bool] Link to this property omit\_background: Optional\[bool] Link to this property optimize\_for\_speed: Optional\[bool] Link to this property quality: Optional\[float] Link to this property

type: Optional\[Literal\["png", "jpeg", "webp"]]

One of the following: "png" Link to this property "jpeg" Link to this property "webp" Link to this property

Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20screenshotOptions%20%3E%20(schema)>) set\_extra\_http\_headers: Optional\[Dict\[str, str]] [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20setExtraHTTPHeaders%20%3E%20(schema)>) set\_java\_script\_enabled: Optional\[[bool]()] [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20setJavaScriptEnabled%20%3E%20(schema)>) user\_agent: Optional\[str] [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20userAgent%20%3E%20(schema)>)

viewport: Optional\[Variant0Viewport] Check options.

height: float Link to this property width: float Link to this property device\_scale\_factor: Optional\[float] Link to this property has\_touch: Optional\[bool] Link to this property is\_landscape: Optional\[bool] Link to this property is\_mobile: Optional\[bool] Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20viewport%20%3E%20(schema)>)

wait\_for\_selector: Optional\[Variant0WaitForSelector] Wait for the selector to appear in page. Check options.

selector: str Link to this property hidden: Optional\[Literal\[true]] Link to this property timeout: Optional\[float] maximum120000 Link to this property visible: Optional\[Literal\[true]] Link to this property

[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20waitForSelector%20%3E%20(schema)>) wait\_for\_timeout: Optional\[float] Waits for a specified timeout before continuing. maximum120000 [Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20waitForTimeout%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class SnapshotCreateResponse: …

accessibility\_tree: Optional\[AccessibilityTree] Accessibility tree node

role: str Link to this property autocomplete: Optional\[str] Link to this property

checked: Optional\[Union\[bool, Literal\["mixed"], null]]

One of the following: bool Link to this property Literal\["mixed"] Link to this property

Link to this property children: Optional\[List\[object]] Link to this property description: Optional\[str] Link to this property disabled: Optional\[bool] Link to this property expanded: Optional\[bool] Link to this property focused: Optional\[bool] Link to this property haspopup: Optional\[str] Link to this property invalid: Optional\[str] Link to this property keyshortcuts: Optional\[str] Link to this property level: Optional\[float] Link to this property modal: Optional\[bool] Link to this property multiline: Optional\[bool] Link to this property multiselectable: Optional\[bool] Link to this property name: Optional\[str] Link to this property orientation: Optional\[str] Link to this property

pressed: Optional\[Union\[bool, Literal\["mixed"], null]]

One of the following: bool Link to this property Literal\["mixed"] Link to this property

Link to this property readonly: Optional\[bool] Link to this property required: Optional\[bool] Link to this property roledescription: Optional\[str] Link to this property selected: Optional\[bool] Link to this property

value: Optional\[Union\[str, float, null]]

One of the following: str Link to this property float Link to this property

Link to this property valuemax: Optional\[float] Link to this property valuemin: Optional\[float] Link to this property valuetext: Optional\[str] Link to this property

Link to this property content: Optional\[str] HTML content. Link to this property markdown: Optional\[str] Markdown content. Prefixed with YAML frontmatter (e.g. title) when the page provides that metadata. Link to this property screenshot: Optional\[str] 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)>) ### Get HTML content and screenshot. Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) snapshot = client.browser_rendering.snapshot.create( account_id="account_id", url="https://www.example.com/", formats=["content", "screenshot"], ) print(snapshot.accessibility_tree) ``` 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "success": true, "errors": [ { "code": 0, "message": "message" } ], "result": { "accessibilityTree": { "role": "role", "autocomplete": "autocomplete", "checked": "mixed", "children": [ {} ], "description": "description", "disabled": true, "expanded": true, "focused": true, "haspopup": "haspopup", "invalid": "invalid", "keyshortcuts": "keyshortcuts", "level": 0, "modal": true, "multiline": true, "multiselectable": true, "name": "name", "orientation": "orientation", "pressed": "mixed", "readonly": true, "required": true, "roledescription": "roledescription", "selected": true, "value": "string", "valuemax": 0, "valuemin": 0, "valuetext": "valuetext" }, "content": "content", "markdown": "markdown", "screenshot": "screenshot" } } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 200 example 429 example ``` { "meta": { "finalUrl": "finalUrl", "headers": { "foo": "string" }, "redirectChain": [ { "headers": { "foo": "string" }, "status": 0, "url": "url" } ], "status": 0, "title": "title" }, "success": true, "errors": [ { "code": 0, "message": "message" } ], "result": { "accessibilityTree": { "role": "role", "autocomplete": "autocomplete", "checked": "mixed", "children": [ {} ], "description": "description", "disabled": true, "expanded": true, "focused": true, "haspopup": "haspopup", "invalid": "invalid", "keyshortcuts": "keyshortcuts", "level": 0, "modal": true, "multiline": true, "multiselectable": true, "name": "name", "orientation": "orientation", "pressed": "mixed", "readonly": true, "required": true, "roledescription": "roledescription", "selected": true, "value": "string", "valuemax": 0, "valuemin": 0, "valuetext": "valuetext" }, "content": "content", "markdown": "markdown", "screenshot": "screenshot" } } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```