Screenshot
render.screenshot.createCapture a public web page or raw HTML as an image. Queued as a durable job: poll render.job.get for the result. Counts one render.screenshot against the organisation's usage when it succeeds; a failed capture counts nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public http(s) page to capture. Private networks are refused. | |
| html | No | Raw HTML to render instead of a URL. Never logged. | |
| width | No | ||
| device | No | desktop | |
| format | No | png | |
| height | No | ||
| delivery | No | Where the finished output goes, by destination id. Register destinations with render.destination.create or in the portal; never a URL or a credential here. | |
| selector | No | CSS selector to capture instead of the viewport. | |
| block_ads | No | ||
| full_page | No | ||
| external_id | No | ||
| hide_selectors | No | CSS selectors to hide before capture. | |
| block_cookie_banners | No | Hide consent overlays without clicking through them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| error | No | ||
| usage | Yes | What the job counts against the organisation's usage: its billing meter, the quantity the product admitted, and the quantity committed once it succeeds, in the meter's units. | |
| cached | Yes | ||
| job_id | Yes | ||
| result | Yes | ||
| status | Yes | ||
| call_id | No | ||
| product | Yes | ||
| created_at | Yes | ||
| request_id | Yes | ||
| connection_id | No |