--- title: Get screenshot. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [Screenshot](https://developers.cloudflare.com/api/go/resources/browser_rendering/subresources/screenshot) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get screenshot. client.BrowserRendering.Screenshot.New(ctx, params) (\*[ScreenshotNewResponse](), error) POST/accounts/{account\_id}/browser-rendering/screenshot Takes a screenshot of a webpage from provided URL or HTML. 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 ScreenshotNewParams 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\[ScreenshotNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). const ScreenshotNewParamsVariant0BrowserKitesurf ScreenshotNewParamsVariant0Browser = "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\[\[]ScreenshotNewParamsVariant0AddScriptTag]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\[\[]ScreenshotNewParamsVariant0AddStyleTag]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\[\[]ScreenshotNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first. const ScreenshotNewParamsVariant0AllowResourceTypeDocument ScreenshotNewParamsVariant0AllowResourceType = "document" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeStylesheet ScreenshotNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeImage ScreenshotNewParamsVariant0AllowResourceType = "image" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeMedia ScreenshotNewParamsVariant0AllowResourceType = "media" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeFont ScreenshotNewParamsVariant0AllowResourceType = "font" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeScript ScreenshotNewParamsVariant0AllowResourceType = "script" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeTexttrack ScreenshotNewParamsVariant0AllowResourceType = "texttrack" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeXHR ScreenshotNewParamsVariant0AllowResourceType = "xhr" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeFetch ScreenshotNewParamsVariant0AllowResourceType = "fetch" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypePrefetch ScreenshotNewParamsVariant0AllowResourceType = "prefetch" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeEventsource ScreenshotNewParamsVariant0AllowResourceType = "eventsource" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeWebsocket ScreenshotNewParamsVariant0AllowResourceType = "websocket" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeManifest ScreenshotNewParamsVariant0AllowResourceType = "manifest" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeSignedexchange ScreenshotNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypePing ScreenshotNewParamsVariant0AllowResourceType = "ping" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeCspviolationreport ScreenshotNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypePreflight ScreenshotNewParamsVariant0AllowResourceType = "preflight" Link to this property const ScreenshotNewParamsVariant0AllowResourceTypeOther ScreenshotNewParamsVariant0AllowResourceType = "other" Link to this property
Link to this property
Authenticate param.Field\[ScreenshotNewParamsVariant0Authenticate]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\[\[]ScreenshotNewParamsVariant0Cookie]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 ScreenshotNewParamsVariant0CookiesPriorityOptional One of the following: const ScreenshotNewParamsVariant0CookiesPriorityLow ScreenshotNewParamsVariant0CookiesPriority = "Low" Link to this property const ScreenshotNewParamsVariant0CookiesPriorityMedium ScreenshotNewParamsVariant0CookiesPriority = "Medium" Link to this property const ScreenshotNewParamsVariant0CookiesPriorityHigh ScreenshotNewParamsVariant0CookiesPriority = "High" Link to this property
Link to this property SameParty boolOptional Link to this property
SameSite ScreenshotNewParamsVariant0CookiesSameSiteOptional One of the following: const ScreenshotNewParamsVariant0CookiesSameSiteStrict ScreenshotNewParamsVariant0CookiesSameSite = "Strict" Link to this property const ScreenshotNewParamsVariant0CookiesSameSiteLax ScreenshotNewParamsVariant0CookiesSameSite = "Lax" Link to this property const ScreenshotNewParamsVariant0CookiesSameSiteNone ScreenshotNewParamsVariant0CookiesSameSite = "None" Link to this property
Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property
SourceScheme ScreenshotNewParamsVariant0CookiesSourceSchemeOptional One of the following: const ScreenshotNewParamsVariant0CookiesSourceSchemeUnset ScreenshotNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const ScreenshotNewParamsVariant0CookiesSourceSchemeNonSecure ScreenshotNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const ScreenshotNewParamsVariant0CookiesSourceSchemeSecure ScreenshotNewParamsVariant0CookiesSourceScheme = "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
GotoOptions param.Field\[ScreenshotNewParamsVariant0GotoOptions]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 ScreenshotNewParamsVariant0GotoOptionsWaitUntilUnionOptional One of the following:
ScreenshotNewParamsVariant0GotoOptionsWaitUntilString One of the following: const ScreenshotNewParamsVariant0GotoOptionsWaitUntilStringLoad ScreenshotNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded ScreenshotNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 ScreenshotNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 ScreenshotNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property
Link to this property
ScreenshotNewParamsVariant0GotoOptionsWaitUntilArray One of the following: const ScreenshotNewParamsVariant0GotoOptionsWaitUntilArrayLoad ScreenshotNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded ScreenshotNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 ScreenshotNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const ScreenshotNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 ScreenshotNewParamsVariant0GotoOptionsWaitUntilArray = "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\[\[]ScreenshotNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’. const ScreenshotNewParamsVariant0RejectResourceTypeDocument ScreenshotNewParamsVariant0RejectResourceType = "document" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeStylesheet ScreenshotNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeImage ScreenshotNewParamsVariant0RejectResourceType = "image" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeMedia ScreenshotNewParamsVariant0RejectResourceType = "media" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeFont ScreenshotNewParamsVariant0RejectResourceType = "font" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeScript ScreenshotNewParamsVariant0RejectResourceType = "script" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeTexttrack ScreenshotNewParamsVariant0RejectResourceType = "texttrack" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeXHR ScreenshotNewParamsVariant0RejectResourceType = "xhr" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeFetch ScreenshotNewParamsVariant0RejectResourceType = "fetch" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypePrefetch ScreenshotNewParamsVariant0RejectResourceType = "prefetch" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeEventsource ScreenshotNewParamsVariant0RejectResourceType = "eventsource" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeWebsocket ScreenshotNewParamsVariant0RejectResourceType = "websocket" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeManifest ScreenshotNewParamsVariant0RejectResourceType = "manifest" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeSignedexchange ScreenshotNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypePing ScreenshotNewParamsVariant0RejectResourceType = "ping" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeCspviolationreport ScreenshotNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypePreflight ScreenshotNewParamsVariant0RejectResourceType = "preflight" Link to this property const ScreenshotNewParamsVariant0RejectResourceTypeOther ScreenshotNewParamsVariant0RejectResourceType = "other" Link to this property
Link to this property
ScreenshotOptions param.Field\[ScreenshotNewParamsVariant0ScreenshotOptions]Optional Body param: Check options. CaptureBeyondViewport boolOptional Link to this property
Clip ScreenshotNewParamsVariant0ScreenshotOptionsClipOptional 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
Encoding ScreenshotNewParamsVariant0ScreenshotOptionsEncodingOptional One of the following: const ScreenshotNewParamsVariant0ScreenshotOptionsEncodingBinary ScreenshotNewParamsVariant0ScreenshotOptionsEncoding = "binary" Link to this property const ScreenshotNewParamsVariant0ScreenshotOptionsEncodingBase64 ScreenshotNewParamsVariant0ScreenshotOptionsEncoding = "base64" 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 ScreenshotNewParamsVariant0ScreenshotOptionsTypeOptional One of the following: const ScreenshotNewParamsVariant0ScreenshotOptionsTypePNG ScreenshotNewParamsVariant0ScreenshotOptionsType = "png" Link to this property const ScreenshotNewParamsVariant0ScreenshotOptionsTypeJPEG ScreenshotNewParamsVariant0ScreenshotOptionsType = "jpeg" Link to this property const ScreenshotNewParamsVariant0ScreenshotOptionsTypeWebP ScreenshotNewParamsVariant0ScreenshotOptionsType = "webp" Link to this property
Link to this property
Link to this property ScrollPage param.Field\[bool]Optional Body param Link to this property Selector param.Field\[string]Optional Body param 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\[ScreenshotNewParamsVariant0Viewport]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\[ScreenshotNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options. Selector string Link to this property Hidden ScreenshotNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible ScreenshotNewParamsVariant0WaitForSelectorVisibleOptional 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.screenshot%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse
type ScreenshotNewResponse struct{…} Success bool Response status. Link to this property
Errors \[]ScreenshotNewResponseErrorOptional Code float64 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)%20ScreenshotNewResponse%20%3E%20(schema)>) ### Get 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"), ) screenshot, err := client.BrowserRendering.Screenshot.New(context.TODO(), browser_rendering.ScreenshotNewParams{ AccountID: cloudflare.F("account_id"), Body: browser_rendering.ScreenshotNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", screenshot.Success) } ``` 200 example 429 example ``` { "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 200 example 429 example ``` { "success": true, "errors": [ { "code": 0, "message": "message" } ] } ``` ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```