---
title: "Generate a screenshot of a widget component."
method: POST
path: "/canvases/widgets/{id}/render"
tags: ["Canvases"]
---

# Generate a screenshot of a widget component.

`POST /canvases/widgets/{id}/render`

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.

## Path parameters

- `id` string, required

## Request body

- WidgetRenderRequest
  - `width` integer — Viewport width in pixels
  - `height` integer — Viewport height in pixels
  - `enable_branding` boolean — Whether to show branding overlay on the widget
  - `enable_filters` boolean — Whether to show filters overlay on the widget
  - `enable_timestamp` boolean — Whether to show timestamp overlay on the widget
  - `filters` DimensionFilter[] — Dimension filters to apply at render time
    - `tld_id` integer, required — Top-level dimension ID
    - `value` string — Dimension member ID to filter by (single-select, backward compatible)
    - `values` string[] — Dimension member IDs to filter by (multi-select)

## Response `200`

Base64-encoded PNG image of the rendered widget component

- object
  - `image` string — Base64-encoded PNG

## Other responses

- `400` — Bad request - invalid parameters
- `404` — Widget not found
- `500` — Error generating screenshot

---

[API](https://skmtc.net/cubesoftware/apis/cube-api.md) · [All operations](https://skmtc.net/cubesoftware/apis/cube-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cubesoftware/cube-api/revisions/67d9f45bb99b/schema)