Skip to content

Commit 2d70514

Browse files
ToriLindsaythomasgauvin
authored andcommitted
[Browser Rendering] Add png note for screenshot API (#24017)
1 parent 48fd320 commit 2d70514

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ console.log(screenshot.status);
4949

5050
For more options to control the final screenshot, like `clip`, `captureBeyondViewport`, `fullPage` and others, check the endpoint [reference](/api/resources/browser_rendering/subresources/screenshot/methods/create/).
5151

52+
:::note
53+
The `quality` parameter is not compatible with the default `.png` format and will return a 400 error. If you set `quality`, you must also set `type` to `.jpeg` or another supported format.
54+
:::
55+
5256
## Advanced usage
5357

5458
Navigate to `https://cloudflare.com/`, changing the page size (`viewport`) and waiting until there are no active network connections (`waitUntil`) or up to a maximum of `4500ms` (`timeout`). Then take a `fullPage` screenshot.

0 commit comments

Comments
 (0)