TRMNL Octri Demo
POST/api/plugin_settings/{plugin_setting_id}/screenshots

Start a plugin setting preview render

Starts a reduced-resolution preview render of a plugin setting so you can check its layout. Set device_model to render for a specific device model, or omit it for the standard preview appearance; size selects the markup dimensions. To drive a device with an image, use /api/display instead.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
plugin_setting_idstringrequired
The plugin setting's ID or UUID to render a preview for.

Optional preview render settings.

device_modelstringoptional
Device model keyname to render on. Omit for the standard preview appearance
sizestringoptional
The markup dimensions to render: `markup_full`, `markup_half_horizontal`, `markup_half_vertical`, or `markup_quadrant`.
Allowed:markup_fullmarkup_half_horizontalmarkup_half_verticalmarkup_quadrant

5 status codes
202Returns a job ID and status for the queued preview render. Each request renders one reduced-resolution image.
dataobjectoptional
401Returned when authentication is missing or invalid.
errorstringoptional
404Returned when the plugin setting UUID belongs to another user.
422Returned when the supplied device model is unknown.
429Returned when the account has exhausted its hourly render allowance shared with the dashboard and MCP.

Error handling

A 401 is returned when authentication is missing or invalid; a 404 is returned when the plugin_setting_id path parameter belongs to another user. A 422 is returned when the supplied device_model is unknown, and size must be one of markup_full, markup_half_horizontal, markup_half_vertical, or markup_quadrant. A 429 is returned when the account has exhausted its hourly render allowance shared with the dashboard and MCP.