Reference
Capture Options
Reference of all request body parameters.
See Capture Studio and Scene Control for detailed guides.
Top Level
| Key | Type | Default | Description |
|---|---|---|---|
url | string | - | Target URL |
html | string | - | HTML content |
markdown | string | - | Markdown content |
format | string | png | png, jpeg, webp, pdf, mp4, gif, webm |
quality | int | 80 | 1-100 (jpeg/webp) |
full_page | bool | false | Capture full height (images only) |
response_type | string | binary | binary, json, empty |
Viewport
| Key | Type | Default | Description |
|---|---|---|---|
viewport.width | int | 1440 | Width in pixels |
viewport.height | int | 900 | Height in pixels |
viewport.device | string | - | Preset ID |
viewport.is_mobile | bool | false | Mobile emulation |
Motion (Video Only)
| Key | Type | Default | Description |
|---|---|---|---|
motion.type | string | still | still or scroll |
motion.duration | int | 5 | Video length in seconds (1-30) |
motion.scroll_by | int | 1000 | Pixels per scroll (100-5000) |
motion.scroll_delay | int | 500 | Pause between scrolls in ms (0-5000) |
motion.scroll_duration | int | 1500 | Scroll animation duration in ms (100-5000) |
motion.easing | string | linear | linear or ease_in_out |
Note: motion parameter is only valid for video formats (mp4, gif, webm). For video formats, it defaults to {"type": "still", "duration": 5} if not specified.
Video Options
| Key | Type | Default | Description |
|---|---|---|---|
video.fps | int | 30 (20 for GIF) | Frames per second (10-60) |
video.quality | int | 30 | CRF value for MP4 (0-63, lower=better) |
video.scale | float | 1.0 | Output scaling multiplier (0.1-2.0) |
video.speed | float | 1.0 | Playback speed multiplier (0.5-2.0) |
Note: video parameter is only valid for video formats (mp4, gif, webm).
Animation (Images)
| Key | Type | Default | Description |
|---|---|---|---|
trigger_animations | bool | true | Enable pre-scroll |
reduce_motion | bool | false | Prefer reduced motion |
full_page_scroll_delay_ms | int | 400 | Scroll pause duration |
Validation Rules
- Video formats (
mp4,gif,webm) cannot be combined withfull_page,selector, orclip - Video formats require
motionparameter (defaults to still if not specified) motionandvideoparameters are only valid for video formats- Only one of
url,html, ormarkdowncan be provided
Refer to the Zod schema in backend/src/validation/capture-request.ts for the definitive source of truth.