--- title: Get PDF. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Browser Rendering](https://developers.cloudflare.com/api/go/resources/browser_rendering) [PDF](https://developers.cloudflare.com/api/go/resources/browser_rendering/subresources/pdf) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get PDF. client.BrowserRendering.PDF.New(ctx, params) (\*Response, error) POST/accounts/{account\_id}/browser-rendering/pdf Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour. ##### 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 PDFNewParams 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\[PDFNewParamsVariant0Browser]Optional Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). const PDFNewParamsVariant0BrowserKitesurf PDFNewParamsVariant0Browser = "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\[\[]PDFNewParamsVariant0AddScriptTag]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\[\[]PDFNewParamsVariant0AddStyleTag]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\[\[]PDFNewParamsVariant0AllowResourceType]Optional Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first. const PDFNewParamsVariant0AllowResourceTypeDocument PDFNewParamsVariant0AllowResourceType = "document" Link to this property const PDFNewParamsVariant0AllowResourceTypeStylesheet PDFNewParamsVariant0AllowResourceType = "stylesheet" Link to this property const PDFNewParamsVariant0AllowResourceTypeImage PDFNewParamsVariant0AllowResourceType = "image" Link to this property const PDFNewParamsVariant0AllowResourceTypeMedia PDFNewParamsVariant0AllowResourceType = "media" Link to this property const PDFNewParamsVariant0AllowResourceTypeFont PDFNewParamsVariant0AllowResourceType = "font" Link to this property const PDFNewParamsVariant0AllowResourceTypeScript PDFNewParamsVariant0AllowResourceType = "script" Link to this property const PDFNewParamsVariant0AllowResourceTypeTexttrack PDFNewParamsVariant0AllowResourceType = "texttrack" Link to this property const PDFNewParamsVariant0AllowResourceTypeXHR PDFNewParamsVariant0AllowResourceType = "xhr" Link to this property const PDFNewParamsVariant0AllowResourceTypeFetch PDFNewParamsVariant0AllowResourceType = "fetch" Link to this property const PDFNewParamsVariant0AllowResourceTypePrefetch PDFNewParamsVariant0AllowResourceType = "prefetch" Link to this property const PDFNewParamsVariant0AllowResourceTypeEventsource PDFNewParamsVariant0AllowResourceType = "eventsource" Link to this property const PDFNewParamsVariant0AllowResourceTypeWebsocket PDFNewParamsVariant0AllowResourceType = "websocket" Link to this property const PDFNewParamsVariant0AllowResourceTypeManifest PDFNewParamsVariant0AllowResourceType = "manifest" Link to this property const PDFNewParamsVariant0AllowResourceTypeSignedexchange PDFNewParamsVariant0AllowResourceType = "signedexchange" Link to this property const PDFNewParamsVariant0AllowResourceTypePing PDFNewParamsVariant0AllowResourceType = "ping" Link to this property const PDFNewParamsVariant0AllowResourceTypeCspviolationreport PDFNewParamsVariant0AllowResourceType = "cspviolationreport" Link to this property const PDFNewParamsVariant0AllowResourceTypePreflight PDFNewParamsVariant0AllowResourceType = "preflight" Link to this property const PDFNewParamsVariant0AllowResourceTypeOther PDFNewParamsVariant0AllowResourceType = "other" Link to this property
Link to this property
Authenticate param.Field\[PDFNewParamsVariant0Authenticate]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\[\[]PDFNewParamsVariant0Cookie]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 PDFNewParamsVariant0CookiesPriorityOptional One of the following: const PDFNewParamsVariant0CookiesPriorityLow PDFNewParamsVariant0CookiesPriority = "Low" Link to this property const PDFNewParamsVariant0CookiesPriorityMedium PDFNewParamsVariant0CookiesPriority = "Medium" Link to this property const PDFNewParamsVariant0CookiesPriorityHigh PDFNewParamsVariant0CookiesPriority = "High" Link to this property
Link to this property SameParty boolOptional Link to this property
SameSite PDFNewParamsVariant0CookiesSameSiteOptional One of the following: const PDFNewParamsVariant0CookiesSameSiteStrict PDFNewParamsVariant0CookiesSameSite = "Strict" Link to this property const PDFNewParamsVariant0CookiesSameSiteLax PDFNewParamsVariant0CookiesSameSite = "Lax" Link to this property const PDFNewParamsVariant0CookiesSameSiteNone PDFNewParamsVariant0CookiesSameSite = "None" Link to this property
Link to this property Secure boolOptional Link to this property SourcePort float64Optional Link to this property
SourceScheme PDFNewParamsVariant0CookiesSourceSchemeOptional One of the following: const PDFNewParamsVariant0CookiesSourceSchemeUnset PDFNewParamsVariant0CookiesSourceScheme = "Unset" Link to this property const PDFNewParamsVariant0CookiesSourceSchemeNonSecure PDFNewParamsVariant0CookiesSourceScheme = "NonSecure" Link to this property const PDFNewParamsVariant0CookiesSourceSchemeSecure PDFNewParamsVariant0CookiesSourceScheme = "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\[PDFNewParamsVariant0GotoOptions]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 PDFNewParamsVariant0GotoOptionsWaitUntilUnionOptional One of the following:
PDFNewParamsVariant0GotoOptionsWaitUntilString One of the following: const PDFNewParamsVariant0GotoOptionsWaitUntilStringLoad PDFNewParamsVariant0GotoOptionsWaitUntilString = "load" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded PDFNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 PDFNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 PDFNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2" Link to this property
Link to this property
PDFNewParamsVariant0GotoOptionsWaitUntilArray One of the following: const PDFNewParamsVariant0GotoOptionsWaitUntilArrayLoad PDFNewParamsVariant0GotoOptionsWaitUntilArray = "load" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded PDFNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 PDFNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0" Link to this property const PDFNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 PDFNewParamsVariant0GotoOptionsWaitUntilArray = "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
PDFOptions param.Field\[PDFNewParamsVariant0PDFOptions]Optional Body param: Check options. DisplayHeaderFooter boolOptional Whether to show the header and footer. Link to this property FooterTemplate stringOptional HTML template for the print footer. Link to this property
Format PDFNewParamsVariant0PDFOptionsFormatOptional Paper format. Takes priority over width and height if set. One of the following: const PDFNewParamsVariant0PDFOptionsFormatLetter PDFNewParamsVariant0PDFOptionsFormat = "letter" Link to this property const PDFNewParamsVariant0PDFOptionsFormatLegal PDFNewParamsVariant0PDFOptionsFormat = "legal" Link to this property const PDFNewParamsVariant0PDFOptionsFormatTabloid PDFNewParamsVariant0PDFOptionsFormat = "tabloid" Link to this property const PDFNewParamsVariant0PDFOptionsFormatLedger PDFNewParamsVariant0PDFOptionsFormat = "ledger" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA0 PDFNewParamsVariant0PDFOptionsFormat = "a0" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA1 PDFNewParamsVariant0PDFOptionsFormat = "a1" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA2 PDFNewParamsVariant0PDFOptionsFormat = "a2" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA3 PDFNewParamsVariant0PDFOptionsFormat = "a3" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA4 PDFNewParamsVariant0PDFOptionsFormat = "a4" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA5 PDFNewParamsVariant0PDFOptionsFormat = "a5" Link to this property const PDFNewParamsVariant0PDFOptionsFormatA6 PDFNewParamsVariant0PDFOptionsFormat = "a6" Link to this property
Link to this property HeaderTemplate stringOptional HTML template for the print header. Link to this property
Height PDFNewParamsVariant0PDFOptionsHeightUnionOptional Sets the height of paper. Can be a number or string with unit. One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property Landscape boolOptional Whether to print in landscape orientation. Link to this property
Margin PDFNewParamsVariant0PDFOptionsMarginOptional Set the PDF margins. Useful when setting header and footer.
Bottom PDFNewParamsVariant0PDFOptionsMarginBottomUnionOptional One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property
Left PDFNewParamsVariant0PDFOptionsMarginLeftUnionOptional One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property
Right PDFNewParamsVariant0PDFOptionsMarginRightUnionOptional One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property
Top PDFNewParamsVariant0PDFOptionsMarginTopUnionOptional One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property
Link to this property OmitBackground boolOptional Hides default white background and allows generating pdfs with transparency. Link to this property Outline boolOptional Generate document outline. Link to this property PageRanges stringOptional Paper ranges to print, e.g. ‘1-5, 8, 11-13’. Link to this property PreferCSSPageSize boolOptional Give CSS @page size priority over other size declarations. Link to this property PrintBackground boolOptional Set to true to print background graphics. Link to this property Scale float64Optional Scales the rendering of the web page. Amount must be between 0.1 and 2. maximum2 minimum0.1 Link to this property Tagged boolOptional Generate tagged (accessible) PDF. Link to this property Timeout float64Optional Timeout in milliseconds. Link to this property
Width PDFNewParamsVariant0PDFOptionsWidthUnionOptional Sets the width of paper. Can be a number or string with unit. One of the following: UnionString Link to this property UnionFloat Link to this property
Link to this property
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\[\[]PDFNewParamsVariant0RejectResourceType]Optional Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’. const PDFNewParamsVariant0RejectResourceTypeDocument PDFNewParamsVariant0RejectResourceType = "document" Link to this property const PDFNewParamsVariant0RejectResourceTypeStylesheet PDFNewParamsVariant0RejectResourceType = "stylesheet" Link to this property const PDFNewParamsVariant0RejectResourceTypeImage PDFNewParamsVariant0RejectResourceType = "image" Link to this property const PDFNewParamsVariant0RejectResourceTypeMedia PDFNewParamsVariant0RejectResourceType = "media" Link to this property const PDFNewParamsVariant0RejectResourceTypeFont PDFNewParamsVariant0RejectResourceType = "font" Link to this property const PDFNewParamsVariant0RejectResourceTypeScript PDFNewParamsVariant0RejectResourceType = "script" Link to this property const PDFNewParamsVariant0RejectResourceTypeTexttrack PDFNewParamsVariant0RejectResourceType = "texttrack" Link to this property const PDFNewParamsVariant0RejectResourceTypeXHR PDFNewParamsVariant0RejectResourceType = "xhr" Link to this property const PDFNewParamsVariant0RejectResourceTypeFetch PDFNewParamsVariant0RejectResourceType = "fetch" Link to this property const PDFNewParamsVariant0RejectResourceTypePrefetch PDFNewParamsVariant0RejectResourceType = "prefetch" Link to this property const PDFNewParamsVariant0RejectResourceTypeEventsource PDFNewParamsVariant0RejectResourceType = "eventsource" Link to this property const PDFNewParamsVariant0RejectResourceTypeWebsocket PDFNewParamsVariant0RejectResourceType = "websocket" Link to this property const PDFNewParamsVariant0RejectResourceTypeManifest PDFNewParamsVariant0RejectResourceType = "manifest" Link to this property const PDFNewParamsVariant0RejectResourceTypeSignedexchange PDFNewParamsVariant0RejectResourceType = "signedexchange" Link to this property const PDFNewParamsVariant0RejectResourceTypePing PDFNewParamsVariant0RejectResourceType = "ping" Link to this property const PDFNewParamsVariant0RejectResourceTypeCspviolationreport PDFNewParamsVariant0RejectResourceType = "cspviolationreport" Link to this property const PDFNewParamsVariant0RejectResourceTypePreflight PDFNewParamsVariant0RejectResourceType = "preflight" Link to this property const PDFNewParamsVariant0RejectResourceTypeOther PDFNewParamsVariant0RejectResourceType = "other" 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\[PDFNewParamsVariant0Viewport]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\[PDFNewParamsVariant0WaitForSelector]Optional Body param: Wait for the selector to appear in page. Check options. Selector string Link to this property Hidden PDFNewParamsVariant0WaitForSelectorHiddenOptional Link to this property Timeout float64Optional maximum120000 Link to this property Visible PDFNewParamsVariant0WaitForSelectorVisibleOptional 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.pdf%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse type PDFNewResponse interface{…} [Link to this property](<#(resource)%20browser_rendering.pdf%20%3E%20(method)%20create%20%3E%20(network%20schema)>) ### Get PDF. 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"), ) pdf, err := client.BrowserRendering.PDF.New(context.TODO(), browser_rendering.PDFNewParams{ AccountID: cloudflare.F("account_id"), Body: browser_rendering.PDFNewParamsBodyObject{ URL: cloudflare.F("https://www.example.com/"), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", pdf) } ``` 429 example ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 429 example ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```