v4

latestOpenAPI 3.1.02026-08-0130252.8 KB

Plugins

Configure a plugin on a slide

Configure a plugin instance on a slide. The config is validated against the plugin's schema and written to the slide's face.plugins.json. Other plugin instances on the slide are preserved. By default this refuses to overwrite an existing instance with the same localName (returns 409) — pass overwrite: true to replace its config, or use a fresh localName to add another instance. After setup, wire the plugin into the slide's face.tsx via its hook (see getPluginDocs).

post/projects/{slug}/slides/{slideId}/plugins

Path parameters

slugstring required

slideIdstring required

Request body

pluginIdstring required

The plugin ID from listPlugins.

localNamestring required

Identifier for this instance, referenced in code as useFormPlugin/usePresenterPlugin(localName). camelCase or snake_case, starting with a letter.

configobject required

Config object matching the plugin's config schema (see getPluginDocs).

overwriteboolean

Set true to replace an existing instance with the same localName. Defaults to false.

Response

Plugin configured

slideIdstring required

versionIdstring required

The new project version ID.

instanceIdstring required

The configured instance id, formatted as ${slideId}.${localName}.

pluginIdstring required

createdboolean required

True if a new instance was created, false if an existing one was overwritten.

warningstring

Present when the config was saved but a post-save side effect (e.g. presenter avatar provisioning) failed. The instance is configured; address the warning and call setupPlugin again with overwrite: true to retry.