Parameter Reference

This page groups the most important POST /v1/capture fields by job. For endpoint-level schema details, see Create Capture.

Source and page loading

Field	Type	Notes
url	string	Required. Must be an http or https URL. Alias: site.
viewport.width / viewport.height	number	Browser viewport before composition.
capture_dpr	number	Browser capture DPR. Valid range: 1 to 4.
wait_for	load | networkidle | domcontentloaded | number	Event or millisecond delay before capture.
full_page	boolean	Capture the full page instead of only the viewport.
dark_mode	boolean	Prefer dark-mode rendering where the page supports it.
hide_selectors	string[]	CSS selectors to hide before capture.
block	string[]	One or more of cookie-banners, ads, chat-widgets, popups.
inject_css	string	CSS applied before capture.

Project and auth

Field	Type	Notes
project_id	string	Optional project scope, such as prj_....
auth_profile_id	string	Optional authenticated browser state, such as ap_....

Element capture

Field	Type	Notes
selector	string	CSS selector for deterministic element capture.
element	string	Natural-language element description. Aliases: component, componentPrompt, component_prompt.
inset	number	Internal padding around captured element. Range: 0 to 100.
inset_balance	boolean	Fill inset using detected component background when possible.
auto_balance	boolean	Let ScreenFramed choose helpful default styling when explicit style is omitted.

Devices and frames

Field	Type	Values
device	string	iphone-16-pro, macbook-pro-16, ipad-pro-m4, browser-macos, browser-windows
device_color	string	Device-specific color variant.
device_scale	number	Range: 0.4 to 1.0.
frame_ratio	string	auto, 16:9, 4:3, 1:1, 3:2, 9:16, 21:9.
frame_scale	number	Advanced frame scale multiplier.

Backgrounds

Field	Type	Values
background_style	string	gradient, solid, none, transparent.
background_preset	string	aurora, sunset, ocean, midnight, arctic, dusk, forest, ember, custom.
background_color	string	CSS color.
background_gradient	string	CSS gradient string.
background	string	Hosted ScreenFramed background reference, e.g. fractal-glass-gradients/fractal-glass-34.
background_image_url	string	Publicly reachable custom image URL. Overrides background when both are provided. Alias: bg_image_url is not supported; use the full field name.

background_style: "transparent" cannot be combined with background, background_preset, or background_image_url, and requires png or webp output.

Layout, camera, and effects

Field	Type	Values / range
aspect_ratio	string	auto, 16:9, 4:3, 1:1, 3:2, 9:16, 21:9.
padding	number	0 to 200.
corner_radius	number	0 to 40.
shadow	string	none, soft, hard, glow, float.
border	string	none, subtle, bold, glass.
camera_preset	string	hero, dashboard, flat, cinematic, detail.
perspective	string	none, tilt-left, tilt-right, tilt-up, tilt-down, tilt-left-strong, tilt-right-strong, iso-left, iso-right.
tilt_x / tilt_y / roll	number	-30 to 30.
zoom	number	50 to 300.
offset_x / offset_y	number	-2000 to 2000.
depth_blur	number	0 to 30.
depth_blur_type	string	dir, radial, tilt, lens.

Text overlays

Field	Type	Notes
title, subtitle, badge	string	Structured text overlay fields.
title_position	string	above, below, bottom-left, top-left, overlay-bottom.
text_enabled	boolean	Enables free-form text overlay.
text_content	string	Max 500 characters.
text_x / text_y	number	Position as a fraction from 0 to 1.
text_size	number	8 to 1200.
text_weight	number	100 to 900.
text_gradient	string	CSS gradient text fill.
text_autofit	boolean	Shrink text to fit a bounded box.

Output

Field	Type	Values / range
output.format	string	png, webp, jpg.
output.width / output.height	number	1 to 6144.
output.quality	number	Format-dependent quality setting.
output.dpr	number	1, 2, or 3.

Removed fields

Field	Replacement
template	Compose with aspect_ratio, device, background_*, and camera controls.
window_controls	Use device: "browser-macos" or device: "browser-windows".