Skip to main content

Extensions

Extension endpoints install, build, compile, configure, run, and remove Picteus extensions:

MethodEndpointPurpose
GET/extension/listLists installed extensions.
GET/extension/{id}/getGets an extension.
POST/extension/installInstalls an extension archive.
PUT/extension/{id}/installChromeExtensionInstalls an extension browser component.
DELETE/extension/{id}/uninstallUninstalls an extension.
PUT/extension/{id}/changeStateChanges an extension state.
PUT/extension/{id}/updateUpdates an extension.
PUT/extension/{id}/compileCompiles an extension.
PUT/extension/buildBuilds an extension.
POST/extension/generateGenerates extension scaffolding.
GET/extension/getConfigurationGets extension configuration.
GET/extension/{id}/getSettingsGets extension settings.
PUT/extension/{id}/setSettingsSets extension settings.
PUT/extension/{id}/resetSettingsResets extension settings.
GET/extension/activitiesReports extension activities.
PUT/extension/{id}/runImageCommandRuns an extension command on images.
PUT/extension/{id}/runProcessCommandRuns an extension command for the process.
PUT/extension/{id}/synchronizeSynchronizes images through an extension.

See the extensions documentation for extension authoring concepts. Endpoint contracts are defined in back-end/openapi.json.

Extension synchronization​

PUT /extension/{id}/synchronize asks the enabled extension to process library images for its declared image capabilities. The back-end schedules image capability events for images that do not yet have results from that extension. See Computing and updating enrichment facets for how the extension computes and writes those results.

Installing and updating extensions​

Picteus provides two special web services for extending the application runtime:

  • POST /extension/install installs an extension;
  • PUT /extension/{id}/update updates an installed extension.

These services enable the application runtime to be augmented with new capabilities, integrations, processing workflows, and user-interface features without modifying the Picteus core. By allowing extensions to be installed and updated through the back-end API, they provide deep flexibility for adapting the application to different tools, automation requirements, and domain-specific workflows.