Update snapshot.mdx

kathayl · web-flow · commit 656eaee9295c · 2025-10-14T09:34:02.000-07:00
- add subheadings
- update to same style as pdf endpoint
diff --git a/src/content/docs/browser-rendering/rest-api/snapshot.mdx b/src/content/docs/browser-rendering/rest-api/snapshot.mdx
@@ -9,8 +9,27 @@ import { Tabs, TabItem, Render } from "~/components";
 
 The `/snapshot` endpoint captures both the HTML content and a screenshot of the webpage in one request. It returns the HTML as a text string and the screenshot as a Base64-encoded image.
 
+## Endpoint
+
+```txt
+https://api.cloudflare.com/client/v4/accounts/<accountId>/browser-rendering/snapshot
+```
+
+## Required fields
+You must provide either `url` or `html`:
+-  `url` (string)
+-  `html` (string)
+
+## Common use cases
+
+-  Capture both the rendered HTML and a visual screenshot in a single API call
+-  Archive pages with visual and structural data together
+-  Build monitoring tools that compare visual and DOM differences over time
+
 ## Basic usage
 
+### Capture a snapshot from a URL
+
 <Tabs syncKey="workersExamples"> <TabItem label="curl">
 
 1. Go to `https://example.com/`.
@@ -64,6 +83,8 @@ console.log(snapshot.content);
 
 ## Advanced usage
 
+### Create a snapshot from custom HTML
+
 The `html` property in the JSON payload, it sets the html to `<html><body>Advanced Snapshot</body></html>` then does the following steps:
 
 1. Disable JavaScript.
