# PDF

## 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.

### Parameters

- `PDFCreateParams = Variant0 | Variant1`

  - `PDFCreateParamsBase`

    - `account_id: string`

      Path param: Account ID.

    - `html: string`

      Body param: Set the content of the page, eg: `<h1>Hello World!!</h1>`. Either `html` or `url` must be set.

    - `cacheTTL?: number`

      Query param: Cache TTL default is 5s. Set to 0 to disable.

    - `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.

    - `addScriptTag?: Array<AddScriptTag>`

      Body param: Adds a `<script>` tag into the page with the desired URL or content.

      - `id?: string`

      - `content?: string`

      - `type?: string`

      - `url?: string`

    - `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`

      - `url?: string`

    - `allowRequestPattern?: Array<string>`

      Body param: Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'.

    - `allowResourceTypes?: Array<"document" | "stylesheet" | "image" | 15 more>`

      Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'.

      - `"document"`

      - `"stylesheet"`

      - `"image"`

      - `"media"`

      - `"font"`

      - `"script"`

      - `"texttrack"`

      - `"xhr"`

      - `"fetch"`

      - `"prefetch"`

      - `"eventsource"`

      - `"websocket"`

      - `"manifest"`

      - `"signedexchange"`

      - `"ping"`

      - `"cspviolationreport"`

      - `"preflight"`

      - `"other"`

    - `authenticate?: Authenticate`

      Body param: Provide credentials for HTTP authentication.

      - `password: string`

      - `username: string`

    - `bestAttempt?: boolean`

      Body param: Attempt to proceed when 'awaited' events fail or timeout.

    - `cookies?: Array<Cookie>`

      Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).

      - `name: string`

        Cookie name.

      - `value: string`

      - `domain?: string`

      - `expires?: number`

      - `httpOnly?: boolean`

      - `partitionKey?: string`

      - `path?: string`

      - `priority?: "Low" | "Medium" | "High"`

        - `"Low"`

        - `"Medium"`

        - `"High"`

      - `sameParty?: boolean`

      - `sameSite?: "Strict" | "Lax" | "None"`

        - `"Strict"`

        - `"Lax"`

        - `"None"`

      - `secure?: boolean`

      - `sourcePort?: number`

      - `sourceScheme?: "Unset" | "NonSecure" | "Secure"`

        - `"Unset"`

        - `"NonSecure"`

        - `"Secure"`

      - `url?: string`

    - `emulateMediaType?: string`

      Body param

    - `gotoOptions?: GotoOptions`

      Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).

      - `referer?: string`

      - `referrerPolicy?: string`

      - `timeout?: number`

      - `waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | Array<"load" | "domcontentloaded" | "networkidle0" | "networkidle2">`

        - `"load" | "domcontentloaded" | "networkidle0" | "networkidle2"`

          - `"load"`

          - `"domcontentloaded"`

          - `"networkidle0"`

          - `"networkidle2"`

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

          - `"load"`

          - `"domcontentloaded"`

          - `"networkidle0"`

          - `"networkidle2"`

    - `pdfOptions?: PDFOptions`

      Body param: Check [options](https://pptr.dev/api/puppeteer.pdfoptions).

      - `displayHeaderFooter?: boolean`

        Whether to show the header and footer.

      - `footerTemplate?: string`

        HTML template for the print footer.

      - `format?: "letter" | "legal" | "tabloid" | 8 more`

        Paper format. Takes priority over width and height if set.

        - `"letter"`

        - `"legal"`

        - `"tabloid"`

        - `"ledger"`

        - `"a0"`

        - `"a1"`

        - `"a2"`

        - `"a3"`

        - `"a4"`

        - `"a5"`

        - `"a6"`

      - `headerTemplate?: string`

        HTML template for the print header.

      - `height?: string | number`

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

        - `string`

        - `number`

      - `landscape?: boolean`

        Whether to print in landscape orientation.

      - `margin?: Margin`

        Set the PDF margins. Useful when setting header and footer.

        - `bottom?: string | number`

          - `string`

          - `number`

        - `left?: string | number`

          - `string`

          - `number`

        - `right?: string | number`

          - `string`

          - `number`

        - `top?: string | number`

          - `string`

          - `number`

      - `omitBackground?: boolean`

        Hides default white background and allows generating pdfs with transparency.

      - `outline?: boolean`

        Generate document outline.

      - `pageRanges?: string`

        Paper ranges to print, e.g. '1-5, 8, 11-13'.

      - `preferCSSPageSize?: boolean`

        Give CSS @page size priority over other size declarations.

      - `printBackground?: boolean`

        Set to true to print background graphics.

      - `scale?: number`

        Scales the rendering of the web page. Amount must be between 0.1 and 2.

      - `tagged?: boolean`

        Generate tagged (accessible) PDF.

      - `timeout?: number`

        Timeout in milliseconds.

      - `width?: string | number`

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

        - `string`

        - `number`

    - `rejectRequestPattern?: Array<string>`

      Body param: Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.

    - `rejectResourceTypes?: Array<"document" | "stylesheet" | "image" | 15 more>`

      Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.

      - `"document"`

      - `"stylesheet"`

      - `"image"`

      - `"media"`

      - `"font"`

      - `"script"`

      - `"texttrack"`

      - `"xhr"`

      - `"fetch"`

      - `"prefetch"`

      - `"eventsource"`

      - `"websocket"`

      - `"manifest"`

      - `"signedexchange"`

      - `"ping"`

      - `"cspviolationreport"`

      - `"preflight"`

      - `"other"`

    - `setExtraHTTPHeaders?: Record<string, string>`

      Body param

    - `setJavaScriptEnabled?: boolean`

      Body param

    - `userAgent?: string`

      Body param

    - `viewport?: Viewport`

      Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).

      - `height: number`

      - `width: number`

      - `deviceScaleFactor?: number`

      - `hasTouch?: boolean`

      - `isLandscape?: boolean`

      - `isMobile?: boolean`

    - `waitForSelector?: WaitForSelector`

      Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).

      - `selector: string`

      - `hidden?: true`

        - `true`

      - `timeout?: number`

      - `visible?: true`

        - `true`

    - `waitForTimeout?: number`

      Body param: Waits for a specified timeout before continuing.

  - `Variant0 extends PDFCreateParamsBase`

  - `Variant1 extends PDFCreateParamsBase`

### Returns

- `unnamed_schema_14 = Response`

### Example

```typescript
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',
  html: '<h1>Hello World!</h1>',
});

console.log(pdf);

const content = await pdf.blob();
console.log(content);
```

#### Response

```json
{
  "errors": [
    {
      "code": 2001,
      "message": "Rate limit exceeded"
    }
  ],
  "success": false
}
```