From 5ad33f22c8d65226e5488a964cbf6290bb77d617 Mon Sep 17 00:00:00 2001 From: kasparasizi1 <132673909+kasparasizi1@users.noreply.github.com> Date: Sat, 10 Oct 2026 19:54:33 +0300 Subject: [PATCH] docs(web): video returns a bounded animated GIF data: URI (SCR-242) video:true now actually records the browser session. Document the data:image/gif;base64 URI format, the bounds (5 fps, 640 px, idle stretches shortened to 3 s, 2 MB with downscale/thinning) and that a failed recording returns the page with video_url null. Co-Authored-By: Claude Opus 5.5 --- api-reference/endpoint/web-scraping/scrape.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/api-reference/endpoint/web-scraping/scrape.mdx b/api-reference/endpoint/web-scraping/scrape.mdx index 2e8ba94..2115e9b 100644 --- a/api-reference/endpoint/web-scraping/scrape.mdx +++ b/api-reference/endpoint/web-scraping/scrape.mdx @@ -261,7 +261,9 @@ openapi: POST /v1/web/scrape - Record a video of the browser session (animated GIF). Forces the browser engine. Returned as base64 in the `video_url` response field. No extra charge — you pay the browser engine cost you were already paying. Useful for debugging, visual verification, or monitoring how a page loads. + Record the browser session, from navigation to the final page, as an animated GIF. Forces the browser engine. Returned in the `video_url` response field as a `data:image/gif;base64,…` URI. No extra charge — you pay the browser engine cost you were already paying. Useful for debugging, visual verification, or monitoring how a page loads. + + The recording is bounded so it stays small enough to return inline: up to 5 frames per second, at most 640 px on its longest side, idle stretches (a `wait_for` or a dwell) shortened to 3 s, and at most 2 MB. A recording over 2 MB is downscaled, then thinned to fewer frames. Recording never fails the scrape: if nothing could be recorded you still get the page, with `video_url: null`. @@ -406,7 +408,7 @@ checked against the estimate *including* the proxy surcharge. - Base64-encoded animated GIF of the browser session. Only present when `video: true` was requested. + The browser session as an animated GIF `data:image/gif;base64,…` URI. Only present when `video: true` was requested; `null` if the session could not be recorded.