TRMNL Octri Demo
POST/api/plugin_installations

Prepare a plugin installation

Prepares an installation from an official plugin or recipe source. Provide the source details and choice_id, and use the required idempotency key to make retries recognizable. A 201 response contains the new installation, while a 200 response contains a retained installation replay.

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

2 parameters · 5 body fields
Idempotency-Keystringrequired
A UUID used to identify this request for idempotency.
X-TRMNL-Configuration-Capabilitiesstringoptional
Configuration capabilities supported by the caller. Maximum 4096 characters.

The plugin or recipe source and the choice used to prepare the installation. kind, source_id, source_revision, and choice_id are required.

choice_idstringrequired
The identifier of the selected installation choice.
device_idintegeroptional
Device whose playlist gets the plugin once the installation completes
kindstringrequired
The source type: `official` or `recipe`.
Allowed:officialrecipe
source_idintegerrequired
The identifier of the official plugin or recipe source.
source_revisionstringrequired
The revision of the selected source.

3 status codes
200Returns the retained installation replay in `data`, including its ID, state, source, plugin setting ID, and expiration time.
dataobjectoptional
201Returns the created installation in `data`, including its ID, state, source, plugin setting ID, and expiration time.
dataobjectoptional
409Returned when the idempotency key conflicts with a prior request.
errorobjectrequired

Error handling

A 409 is returned when the Idempotency-Key header conflicts with a prior request. The body must include kind, source_id, source_revision, and choice_id; kind must be official or recipe. The required Idempotency-Key header must be a UUID, and X-TRMNL-Configuration-Capabilities must not exceed 4096 characters when provided.