Plugin Settings - Preview

Start a preview render of a plugin instance

Renders the instance so you can check its layout. The image comes back at reduced resolution and is not sized for a panel; a device is driven through /api/display.

post/api/plugin_settings/{plugin_setting_id}/screenshots

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/plugin_settings/{plugin_setting_id}/screenshots
  • Auth: HTTP bearer

Path parameters

plugin_setting_idstring required

Plugin setting id or uuid

Request body

size'markup_full' | 'markup_half_horizontal' | 'markup_half_vertical' | 'markup_quadrant'
device_modelstring nullable

Device model keyname to render on. Omit for the standard preview appearance

Example request

{
  "size": "markup_full",
  "device_model": "og"
}

Response

Renders one reduced image per request, however many the MCP tools batch at once

Example response

{
  "data": {
    "status": "pending"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.