# Screenshot

## Get screenshot.

`browser_rendering.screenshot.create(ScreenshotCreateParams**kwargs)  -> 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

- `account_id: str`

  Account ID.

- `html: str`

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

- `cache_ttl: Optional[float]`

  Cache TTL default is 5s. Set to 0 to disable.

- `action_timeout: Optional[float]`

  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.

- `add_script_tag: Optional[Iterable[Variant0AddScriptTag]]`

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

  - `id: Optional[str]`

  - `content: Optional[str]`

  - `type: Optional[str]`

  - `url: Optional[str]`

- `add_style_tag: Optional[Iterable[Variant0AddStyleTag]]`

  Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.

  - `content: Optional[str]`

  - `url: Optional[str]`

- `allow_request_pattern: Optional[SequenceNotStr[str]]`

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

- `allow_resource_types: Optional[List[Literal["document", "stylesheet", "image", 15 more]]]`

  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: Optional[Variant0Authenticate]`

  Provide credentials for HTTP authentication.

  - `password: str`

  - `username: str`

- `best_attempt: Optional[bool]`

  Attempt to proceed when 'awaited' events fail or timeout.

- `cookies: Optional[Iterable[Variant0Cookie]]`

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

  - `name: str`

    Cookie name.

  - `value: str`

  - `domain: Optional[str]`

  - `expires: Optional[float]`

  - `http_only: Optional[bool]`

  - `partition_key: Optional[str]`

  - `path: Optional[str]`

  - `priority: Optional[Literal["Low", "Medium", "High"]]`

    - `"Low"`

    - `"Medium"`

    - `"High"`

  - `same_party: Optional[bool]`

  - `same_site: Optional[Literal["Strict", "Lax", "None"]]`

    - `"Strict"`

    - `"Lax"`

    - `"None"`

  - `secure: Optional[bool]`

  - `source_port: Optional[float]`

  - `source_scheme: Optional[Literal["Unset", "NonSecure", "Secure"]]`

    - `"Unset"`

    - `"NonSecure"`

    - `"Secure"`

  - `url: Optional[str]`

- `emulate_media_type: Optional[str]`

- `goto_options: Optional[Variant0GotoOptions]`

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

  - `referer: Optional[str]`

  - `referrer_policy: Optional[str]`

  - `timeout: Optional[float]`

  - `wait_until: Optional[Union[Literal["load", "domcontentloaded", "networkidle0", "networkidle2"], List[Literal["load", "domcontentloaded", "networkidle0", "networkidle2"]]]]`

    - `Literal["load", "domcontentloaded", "networkidle0", "networkidle2"]`

      - `"load"`

      - `"domcontentloaded"`

      - `"networkidle0"`

      - `"networkidle2"`

    - `List[Literal["load", "domcontentloaded", "networkidle0", "networkidle2"]]`

      - `"load"`

      - `"domcontentloaded"`

      - `"networkidle0"`

      - `"networkidle2"`

- `reject_request_pattern: Optional[SequenceNotStr[str]]`

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

- `reject_resource_types: Optional[List[Literal["document", "stylesheet", "image", 15 more]]]`

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

- `screenshot_options: Optional[Variant0ScreenshotOptions]`

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

  - `capture_beyond_viewport: Optional[bool]`

  - `clip: Optional[Variant0ScreenshotOptionsClip]`

    - `height: float`

    - `width: float`

    - `x: float`

    - `y: float`

    - `scale: Optional[float]`

  - `encoding: Optional[Literal["binary", "base64"]]`

    - `"binary"`

    - `"base64"`

  - `from_surface: Optional[bool]`

  - `full_page: Optional[bool]`

  - `omit_background: Optional[bool]`

  - `optimize_for_speed: Optional[bool]`

  - `quality: Optional[float]`

  - `type: Optional[Literal["png", "jpeg", "webp"]]`

    - `"png"`

    - `"jpeg"`

    - `"webp"`

- `scroll_page: Optional[bool]`

- `selector: Optional[str]`

- `set_extra_http_headers: Optional[Dict[str, str]]`

- `set_java_script_enabled: Optional[bool]`

- `user_agent: Optional[str]`

- `viewport: Optional[Variant0Viewport]`

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

  - `height: float`

  - `width: float`

  - `device_scale_factor: Optional[float]`

  - `has_touch: Optional[bool]`

  - `is_landscape: Optional[bool]`

  - `is_mobile: Optional[bool]`

- `wait_for_selector: Optional[Variant0WaitForSelector]`

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

  - `selector: str`

  - `hidden: Optional[Literal[true]]`

    - `true`

  - `timeout: Optional[float]`

  - `visible: Optional[Literal[true]]`

    - `true`

- `wait_for_timeout: Optional[float]`

  Waits for a specified timeout before continuing.

### Returns

- `class ScreenshotCreateResponse: …`

  - `success: bool`

    Response status.

  - `errors: Optional[List[Error]]`

    - `code: float`

      Error code.

    - `message: str`

      Error message.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
screenshot = client.browser_rendering.screenshot.create(
    account_id="account_id",
    html="<h1>Hello World!</h1>",
)
print(screenshot.success)
```

#### Response

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

## Domain Types

### Screenshot Create Response

- `class ScreenshotCreateResponse: …`

  - `success: bool`

    Response status.

  - `errors: Optional[List[Error]]`

    - `code: float`

      Error code.

    - `message: str`

      Error message.