# Screenshot

## Get screenshot.

`client.browserRendering.screenshot.create(ScreenshotCreateParamsparams, RequestOptionsoptions?): ScreenshotCreateResponse`

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

### Parameters

- `ScreenshotCreateParams = Variant0 | Variant1`

  - `ScreenshotCreateParamsBase`

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

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

    - `screenshotOptions?: ScreenshotOptions`

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

      - `captureBeyondViewport?: boolean`

      - `clip?: Clip`

        - `height: number`

        - `width: number`

        - `x: number`

        - `y: number`

        - `scale?: number`

      - `encoding?: "binary" | "base64"`

        - `"binary"`

        - `"base64"`

      - `fromSurface?: boolean`

      - `fullPage?: boolean`

      - `omitBackground?: boolean`

      - `optimizeForSpeed?: boolean`

      - `quality?: number`

      - `type?: "png" | "jpeg" | "webp"`

        - `"png"`

        - `"jpeg"`

        - `"webp"`

    - `scrollPage?: boolean`

      Body param

    - `selector?: string`

      Body param

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

  - `Variant1 extends ScreenshotCreateParamsBase`

### Returns

- `ScreenshotCreateResponse`

  - `success: boolean`

    Response status.

  - `errors?: Array<Error>`

    - `code: number`

      Error code.

    - `message: string`

      Error message.

### 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 screenshot = await client.browserRendering.screenshot.create({
  account_id: 'account_id',
  html: '<h1>Hello World!</h1>',
});

console.log(screenshot.success);
```

#### Response

```json
{
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ]
}
```

## Domain Types

### Screenshot Create Response

- `ScreenshotCreateResponse`

  - `success: boolean`

    Response status.

  - `errors?: Array<Error>`

    - `code: number`

      Error code.

    - `message: string`

      Error message.