--- title: Get PDF. --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Browser Rendering](https://developers.cloudflare.com/api/typescript/resources/browser_rendering) [PDF](https://developers.cloudflare.com/api/typescript/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.create(PDFCreateParamsparams, RequestOptionsoptions?): Response 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

PDFCreateParams = Variant0| Variant1

PDFCreateParamsBase {account\_id, url, browser, 21 more }

account\_id: string Path param: Account ID. Link to this property url: string Body param Link to this property browser?: "kitesurf" Query param: Rendering backend. Set to kitesurf to use Kitesurf (beta). Link to this property cacheTTL?: number Query param: Cache TTL default is 5s. Set to 0 to disable. maximum86400 minimum0 Link to this property actionTimeout?: number 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?: Array<AddScriptTag> Body param: Adds a script element into the page with the desired URL or content.

id?: string Link to this property content?: string Link to this property type?: string Link to this property url?: string formaturi Link to this property

Link to this property

addStyleTag?: Array<AddStyleTag> 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?: string Link to this property url?: string formaturi Link to this property

Link to this property allowRequestPattern?: Array<string> Body param: Only allow requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Reject rules are applied first. Link to this property

allowResourceTypes?: Array<"document"| "stylesheet"| "image"| 15 more> Body param: Only allow requests that match the provided resource types, eg. ‘image’ or ‘script’. Reject rules are applied first.

Link to this property

authenticate?: Authenticate 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?: boolean Body param: Attempt to proceed when ‘awaited’ events fail or timeout. Link to this property

cookies?: Array<Cookie> Body param: Check options.

name: string Cookie name. Link to this property value: string Link to this property domain?: string Link to this property expires?: number Link to this property httpOnly?: boolean Link to this property partitionKey?: string Link to this property path?: string Link to this property

priority?: "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 sameParty?: boolean Link to this property

sameSite?: "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?: boolean Link to this property sourcePort?: number Link to this property

sourceScheme?: "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?: string Link to this property

Link to this property emulateMediaType?: string Body param Link to this property

gotoOptions?: GotoOptions Body param: Check options.

referer?: string Link to this property referrerPolicy?: string Link to this property timeout?: number maximum60000 Link to this property

One of the following:

"load"| "domcontentloaded"| "networkidle0"| "networkidle2"

"load" Link to this property "domcontentloaded" Link to this property "networkidle0" Link to this property "networkidle2" Link to this property

Link to this property

Array<"load"| "domcontentloaded"| "networkidle0"| "networkidle2">

"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 html?: string Body param Link to this property

pdfOptions?: PDFOptions Body param: Check options.

displayHeaderFooter?: boolean Whether to show the header and footer. Link to this property footerTemplate?: string HTML template for the print footer. Link to this property

format?: "letter"| "legal"| "tabloid"| 8 more Paper format. Takes priority over width and height if set.

One of the following: "letter" Link to this property "legal" Link to this property "tabloid" Link to this property "ledger" Link to this property "a0" Link to this property "a1" Link to this property "a2" Link to this property "a3" Link to this property "a4" Link to this property "a5" Link to this property "a6" Link to this property

Link to this property headerTemplate?: string HTML template for the print header. Link to this property

height?: string| number Sets the height of paper. Can be a number or string with unit.

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

Link to this property landscape?: boolean Whether to print in landscape orientation. Link to this property

margin?: Margin {bottom, left, right, top } Set the PDF margins. Useful when setting header and footer.

bottom?: string| number

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

Link to this property

left?: string| number

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

Link to this property

right?: string| number

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

Link to this property

top?: string| number

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

Link to this property

Link to this property omitBackground?: boolean Hides default white background and allows generating pdfs with transparency. Link to this property outline?: boolean Generate document outline. Link to this property pageRanges?: string Paper ranges to print, e.g. ‘1-5, 8, 11-13’. Link to this property preferCSSPageSize?: boolean Give CSS @page size priority over other size declarations. Link to this property printBackground?: boolean Set to true to print background graphics. Link to this property scale?: number Scales the rendering of the web page. Amount must be between 0.1 and 2. maximum2 minimum0.1 Link to this property tagged?: boolean Generate tagged (accessible) PDF. Link to this property timeout?: number Timeout in milliseconds. Link to this property

width?: string| number Sets the width of paper. Can be a number or string with unit.

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

Link to this property

Link to this property rejectRequestPattern?: Array<string> Body param: Block undesired requests that match the provided regex patterns, eg. ’/^.\*.(css)’. Link to this property

rejectResourceTypes?: Array<"document"| "stylesheet"| "image"| 15 more> Body param: Block undesired requests that match the provided resource types, eg. ‘image’ or ‘script’.

Link to this property setExtraHTTPHeaders?: Record<string, string> Body param Link to this property setJavaScriptEnabled?: boolean Body param Link to this property userAgent?: string Body param Link to this property

viewport?: Viewport Body param: Check options.

height: number Link to this property width: number Link to this property deviceScaleFactor?: number Link to this property hasTouch?: boolean Link to this property isLandscape?: boolean Link to this property isMobile?: boolean Link to this property

Link to this property

waitForSelector?: WaitForSelector Body param: Wait for the selector to appear in page. Check options.

selector: string Link to this property hidden?: true Link to this property timeout?: number maximum120000 Link to this property visible?: true Link to this property

Link to this property waitForTimeout?: number Body param: Waits for a specified timeout before continuing. maximum120000 Link to this property

Link to this property Variant0 extends PDFCreateParamsBase {account\_id, url, browser, 21 more } Link to this property Variant1 extends PDFCreateParamsBase {account\_id, url, browser, 21 more } Link to this property

[Link to this property](<#(resource)%20browser_rendering.pdf%20%3E%20(method)%20create.typescript.params>) ##### ReturnsExpand Collapse unnamed\_schema\_15 = Response [Link to this property](<#(resource)%20browser_rendering.pdf%20%3E%20(method)%20create%20%3E%20(network%20schema)>) ### Get PDF. TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const pdf = await client.browserRendering.pdf.create({ account_id: 'account_id', url: 'https://www.example.com/', }); console.log(pdf); const content = await pdf.blob(); console.log(content); ``` 429 example ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ``` ##### Returns Examples 429 example ``` { "errors": [ { "code": 2001, "message": "Rate limit exceeded" } ], "success": false } ```