--- title: Get HTML content and screenshot. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [Snapshot](https://developers.cloudflare.com/api/go/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. client.BrowserRendering.Snapshot.New(ctx, params) (\*[SnapshotNewResponse](), error) 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
params SnapshotNewParams AccountID param.Field\[string] Path param: Account ID. Link to this property URL param.Field\[string] Body param Link to this property
Browser param.Field\[SnapshotNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). const SnapshotNewParamsVariant0BrowserKitesurf SnapshotNewParamsVariant0Browser = "kitesurf" Link to this property
Link to this property CacheTTL param.Field\[float64]Optional Query param: Cache TTL default is 5s. Set to 0 to disable. maximum86400 minimum0 Link to this property ActionTimeout param.Field\[float64]Optional Body param: 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
AddScriptTag param.Field\[\[]SnapshotNewParamsVariant0AddScriptTag]Optional Body param: Adds a script element into the page with the desired URL or content. ID stringOptional Link to this property Content stringOptional Link to this property Type stringOptional Link to this property URL stringOptional formaturi Link to this property
Link to this property
AddStyleTag param.Field\[\[]SnapshotNewParamsVariant0AddStyleTag]Optional Body param: Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content. Content stringOptional Link to this property URL stringOptional formaturi Link to this property
Link to this property AllowRequestPattern param.Field\[\[]string]Optional Body param: Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first. Link to this property
AllowResourceTypes param.Field\[\[]SnapshotNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first. const SnapshotNewParamsVariant0AllowResourceTypeDocument SnapshotNewParamsVariant0AllowResourceType = "document" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeStylesheet SnapshotNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeImage SnapshotNewParamsVariant0AllowResourceType = "image" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeMedia SnapshotNewParamsVariant0AllowResourceType = "media" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeFont SnapshotNewParamsVariant0AllowResourceType = "font" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeScript SnapshotNewParamsVariant0AllowResourceType = "script" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeTexttrack SnapshotNewParamsVariant0AllowResourceType = "texttrack" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeXHR SnapshotNewParamsVariant0AllowResourceType = "xhr" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeFetch SnapshotNewParamsVariant0AllowResourceType = "fetch" Link to this property const SnapshotNewParamsVariant0AllowResourceTypePrefetch SnapshotNewParamsVariant0AllowResourceType = "prefetch" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeEventsource SnapshotNewParamsVariant0AllowResourceType = "eventsource" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeWebsocket SnapshotNewParamsVariant0AllowResourceType = "websocket" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeManifest SnapshotNewParamsVariant0AllowResourceType = "manifest" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeSignedexchange SnapshotNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const SnapshotNewParamsVariant0AllowResourceTypePing SnapshotNewParamsVariant0AllowResourceType = "ping" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeCspviolationreport SnapshotNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const SnapshotNewParamsVariant0AllowResourceTypePreflight SnapshotNewParamsVariant0AllowResourceType = "preflight" Link to this property const SnapshotNewParamsVariant0AllowResourceTypeOther SnapshotNewParamsVariant0AllowResourceType = "other" Link to this property
Link to this property
Authenticate param.Field\[SnapshotNewParamsVariant0Authenticate]Optional Body param: Provide credentials for HTTP authentication. Password string minLength1 Link to this property Username string minLength1 Link to this property
Link to this property BestAttempt param.Field\[bool]Optional Body param: Attempt to proceed when ‘awaited’ events fail or timeout. Link to this property
Cookies param.Field\[\[]SnapshotNewParamsVariant0Cookie]Optional Body param: Check options. Name string Cookie name. Link to this property Value string Link to this property Domain stringOptional Link to this property Expires float64Optional Link to this property HTTPOnly boolOptional Link to this property PartitionKey stringOptional Link to this property Path stringOptional Link to this property
Priority SnapshotNewParamsVariant0CookiesPriorityOptional One of the following: const SnapshotNewParamsVariant0CookiesPriorityLow SnapshotNewParamsVariant0CookiesPriority = "Low" Link to this property const SnapshotNewParamsVariant0CookiesPriorityMedium SnapshotNewParamsVariant0CookiesPriority = "Medium" Link to this property const SnapshotNewParamsVariant0CookiesPriorityHigh SnapshotNewParamsVariant0CookiesPriority = "High" Link to this property
Link to this property SameParty boolOptional Link to this property
SameSite SnapshotNewParamsVariant0CookiesSameSiteOptional One of the following: const SnapshotNewParamsVariant0CookiesSameSiteStrict SnapshotNewParamsVariant0CookiesSameSite = "Strict" Link to this property const SnapshotNewParamsVariant0CookiesSameSiteLax SnapshotNewParamsVariant0CookiesSameSite = "Lax" Link to this property const SnapshotNewParamsVariant0CookiesSameSiteNone SnapshotNewParamsVariant0CookiesSameSite = "None" Link to this property
Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property
SourceScheme SnapshotNewParamsVariant0CookiesSourceSchemeOptional One of the following: const SnapshotNewParamsVariant0CookiesSourceSchemeUnset SnapshotNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const SnapshotNewParamsVariant0CookiesSourceSchemeNonSecure SnapshotNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const SnapshotNewParamsVariant0CookiesSourceSchemeSecure SnapshotNewParamsVariant0CookiesSourceScheme = "Secure" Link to this property
Link to this property URL stringOptional Link to this property
Link to this property EmulateMediaType param.Field\[string]Optional Body param Link to this property
Formats param.Field\[\[]SnapshotNewParamsVariant0Format]Optional Body param const SnapshotNewParamsVariant0FormatContent SnapshotNewParamsVariant0Format = "content" Link to this property const SnapshotNewParamsVariant0FormatScreenshot SnapshotNewParamsVariant0Format = "screenshot" Link to this property const SnapshotNewParamsVariant0FormatMarkdown SnapshotNewParamsVariant0Format = "markdown" Link to this property const SnapshotNewParamsVariant0FormatAccessibilityTree SnapshotNewParamsVariant0Format = "accessibilityTree" Link to this property
Link to this property
GotoOptions param.Field\[SnapshotNewParamsVariant0GotoOptions]Optional Body param: Check options. Referer stringOptional Link to this property ReferrerPolicy stringOptional Link to this property Timeout float64Optional maximum60000 Link to this property
WaitUntil SnapshotNewParamsVariant0GotoOptionsWaitUntilUnionOptional One of the following:
SnapshotNewParamsVariant0GotoOptionsWaitUntilString One of the following: const SnapshotNewParamsVariant0GotoOptionsWaitUntilStringLoad SnapshotNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded SnapshotNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 SnapshotNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 SnapshotNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property
Link to this property
SnapshotNewParamsVariant0GotoOptionsWaitUntilArray One of the following: const SnapshotNewParamsVariant0GotoOptionsWaitUntilArrayLoad SnapshotNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded SnapshotNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 SnapshotNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const SnapshotNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 SnapshotNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2" Link to this property
Link to this property
Link to this property
Link to this property HTML param.Field\[string]Optional Body param Link to this property RejectRequestPattern param.Field\[\[]string]Optional Body param: Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Link to this property
RejectResourceTypes param.Field\[\[]SnapshotNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’. const SnapshotNewParamsVariant0RejectResourceTypeDocument SnapshotNewParamsVariant0RejectResourceType = "document" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeStylesheet SnapshotNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeImage SnapshotNewParamsVariant0RejectResourceType = "image" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeMedia SnapshotNewParamsVariant0RejectResourceType = "media" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeFont SnapshotNewParamsVariant0RejectResourceType = "font" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeScript SnapshotNewParamsVariant0RejectResourceType = "script" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeTexttrack SnapshotNewParamsVariant0RejectResourceType = "texttrack" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeXHR SnapshotNewParamsVariant0RejectResourceType = "xhr" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeFetch SnapshotNewParamsVariant0RejectResourceType = "fetch" Link to this property const SnapshotNewParamsVariant0RejectResourceTypePrefetch SnapshotNewParamsVariant0RejectResourceType = "prefetch" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeEventsource SnapshotNewParamsVariant0RejectResourceType = "eventsource" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeWebsocket SnapshotNewParamsVariant0RejectResourceType = "websocket" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeManifest SnapshotNewParamsVariant0RejectResourceType = "manifest" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeSignedexchange SnapshotNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const SnapshotNewParamsVariant0RejectResourceTypePing SnapshotNewParamsVariant0RejectResourceType = "ping" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeCspviolationreport SnapshotNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const SnapshotNewParamsVariant0RejectResourceTypePreflight SnapshotNewParamsVariant0RejectResourceType = "preflight" Link to this property const SnapshotNewParamsVariant0RejectResourceTypeOther SnapshotNewParamsVariant0RejectResourceType = "other" Link to this property
Link to this property
ScreenshotOptions param.Field\[SnapshotNewParamsVariant0ScreenshotOptions]Optional Body param CaptureBeyondViewport boolOptional Link to this property
Clip SnapshotNewParamsVariant0ScreenshotOptionsClipOptional Height float64 Link to this property Width float64 Link to this property X float64 Link to this property Y float64 Link to this property Scale float64Optional Link to this property
Link to this property FromSurface boolOptional Link to this property FullPage boolOptional Link to this property OmitBackground boolOptional Link to this property OptimizeForSpeed boolOptional Link to this property Quality float64Optional Link to this property
Type SnapshotNewParamsVariant0ScreenshotOptionsTypeOptional One of the following: const SnapshotNewParamsVariant0ScreenshotOptionsTypePNG SnapshotNewParamsVariant0ScreenshotOptionsType = "png" Link to this property const SnapshotNewParamsVariant0ScreenshotOptionsTypeJPEG SnapshotNewParamsVariant0ScreenshotOptionsType = "jpeg" Link to this property const SnapshotNewParamsVariant0ScreenshotOptionsTypeWebP SnapshotNewParamsVariant0ScreenshotOptionsType = "webp" Link to this property
Link to this property
Link to this property SetExtraHTTPHeaders param.Field\[map\[string, string]]Optional Body param Link to this property SetJavaScriptEnabled param.Field\[bool]Optional Body param Link to this property UserAgent param.Field\[string]Optional Body param Link to this property
Viewport param.Field\[SnapshotNewParamsVariant0Viewport]Optional Body param: Check options. Height float64 Link to this property Width float64 Link to this property DeviceScaleFactor float64Optional Link to this property HasTouch boolOptional Link to this property IsLandscape boolOptional Link to this property IsMobile boolOptional Link to this property
Link to this property
WaitForSelector param.Field\[SnapshotNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options. Selector string Link to this property Hidden SnapshotNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible SnapshotNewParamsVariant0WaitForSelectorVisibleOptional Link to this property
Link to this property WaitForTimeout param.Field\[float64]Optional Body param: Waits for a specified timeout before continuing. maximum120000 Link to this property
[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse
type SnapshotNewResponse struct{…}
AccessibilityTree SnapshotNewResponseAccessibilityTreeOptional Accessibility tree node Role string Link to this property Autocomplete stringOptional Link to this property
Checked SnapshotNewResponseAccessibilityTreeCheckedUnionOptional One of the following: UnionBool Link to this property type SnapshotNewResponseAccessibilityTreeCheckedString string Link to this property
Link to this property Children \[]unknownOptional Link to this property Description stringOptional Link to this property Disabled boolOptional Link to this property Expanded boolOptional Link to this property Focused boolOptional Link to this property Haspopup stringOptional Link to this property Invalid stringOptional Link to this property Keyshortcuts stringOptional Link to this property Level float64Optional Link to this property Modal boolOptional Link to this property Multiline boolOptional Link to this property Multiselectable boolOptional Link to this property Name stringOptional Link to this property Orientation stringOptional Link to this property
Pressed SnapshotNewResponseAccessibilityTreePressedUnionOptional One of the following: UnionBool Link to this property type SnapshotNewResponseAccessibilityTreePressedString string Link to this property
Link to this property Readonly boolOptional Link to this property Required boolOptional Link to this property Roledescription stringOptional Link to this property Selected boolOptional Link to this property
Value SnapshotNewResponseAccessibilityTreeValueUnionOptional One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property Valuemax float64Optional Link to this property Valuemin float64Optional Link to this property Valuetext stringOptional Link to this property
Link to this property Content stringOptional HTML content. Link to this property Markdown stringOptional Markdown content. Prefixed with YAML frontmatter (e.g. title) when the page provides that metadata. Link to this property Screenshot stringOptional Base64 encoded image. Link to this property
[Link to this property](<#(resource)%20browser_rendering.snapshot%20%3E%20(model)%20SnapshotNewResponse%20%3E%20(schema)>) ### Get HTML content and screenshot. Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/browser_rendering" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) snapshot, err := client.BrowserRendering.Snapshot.New(context.TODO(), browser_rendering.SnapshotNewParams{ AccountID: cloudflare.F("account_id"), Body: browser_rendering.SnapshotNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", snapshot.AccessibilityTree) } ``` 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 } ```