Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Canvases

Generate a screenshot of a widget component.

Generates a PNG screenshot of the widget component by rendering it in a headless browser.

  • The screenshot is uploaded to S3 for record keeping.
  • Returns the PNG image directly.
  • Optional rendering parameters can be provided in the request body.
post/canvases/widgets/{id}/render

Path parameters

idstring required

Request body

widthinteger

Viewport width in pixels

heightinteger

Viewport height in pixels

enable_brandingboolean

Whether to show branding overlay on the widget

enable_filtersboolean

Whether to show filters overlay on the widget

enable_timestampboolean

Whether to show timestamp overlay on the widget

Response

Base64-encoded PNG image of the rendered widget component

imagestring

Base64-encoded PNG