TRMNL Octri Demo
GET/api/plugin_settings/{plugin_setting_id}/screenshots/{id}

Get the result of a plugin setting preview render

Retrieves the result of a preview render for a plugin setting. Use the id returned when you started the render to check its status or retrieve the rendered image. The image is returned as a base64-encoded value when the render is complete.

2 parameters
plugin_setting_idstringrequired
The plugin setting's ID or UUID for the preview render.
idstringrequired
The preview render job ID returned when you started the render.

6 status codes
200Returns the completed preview render result, including the job ID, status, and base64-encoded image.
dataobjectoptional
202Returns a pending status while the render is still processing.
401Returned when authentication is missing or invalid.
errorstringoptional
404Returned when the plugin setting UUID belongs to another user.
410Returned when the result has expired or the job ID was never issued.
422Returned when the render failed.

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 410 is returned when the result has expired or the id path parameter was never issued. A 422 is returned when the render failed.