Plugin Manifests

Overview

The QIMEM platform supports an extensible plugin system that allows you to extend platform functionality with custom plugins. Plugins can be written in multiple runtimes (WASM, Python, JavaScript, Lua) and declare their capabilities through a manifest system. The plugin manifest API provides endpoints to:

List all registered plugin manifests
Register new plugins with the platform

Plugin Manifest Structure

name

string

required

Unique plugin name that identifies the plugin in the system

version

string

required

Semantic version of the plugin (e.g., “1.0.0”, “2.1.3”)

runtime

string

required

Runtime type that executes the plugin. Supported values include:

wasm - WebAssembly runtime
python - Python runtime
js - JavaScript runtime
lua - Lua runtime

capabilities

array

required

Array of strings declaring the capabilities exposed by the plugin. Examples include data processing, authentication, storage, etc.

List Plugin Manifests

curl -X GET https://api.qimem.com/v1/plugins/manifests \
  -H "Content-Type: application/json"

Response

plugins

array

Array of plugin manifest objects

name

string

Unique plugin name

version

string

Semantic version

runtime

string

Runtime type (wasm, python, js, lua)

capabilities

array

Array of capability strings

Example Response

[
  {
    "name": "data-processor",
    "version": "1.2.0",
    "runtime": "wasm",
    "capabilities": ["transform", "validate", "filter"]
  },
  {
    "name": "auth-extension",
    "version": "2.0.1",
    "runtime": "python",
    "capabilities": ["oauth2", "saml", "ldap"]
  }
]

Register Plugin Manifest

WASM Plugin
Python Plugin
JavaScript Plugin
Lua Plugin

cURL

curl -X POST https://api.qimem.com/v1/plugins/manifests \
  -H "Content-Type: application/json" \
  -d '{
    "name": "wasm-processor",
    "version": "1.0.0",
    "runtime": "wasm",
    "capabilities": ["compute", "transform", "analyze"]
  }'

WASM plugins offer high performance and security through sandboxed execution. Ideal for compute-intensive operations.

cURL

curl -X POST https://api.qimem.com/v1/plugins/manifests \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ml-inference",
    "version": "2.1.0",
    "runtime": "python",
    "capabilities": ["predict", "train", "evaluate"]
  }'

Python plugins are excellent for machine learning, data science, and integration with the Python ecosystem.

cURL

curl -X POST https://api.qimem.com/v1/plugins/manifests \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ui-extension",
    "version": "1.5.2",
    "runtime": "js",
    "capabilities": ["render", "validate", "format"]
  }'

JavaScript plugins are perfect for UI extensions, formatting, and rapid prototyping with familiar syntax.

cURL

curl -X POST https://api.qimem.com/v1/plugins/manifests \
  -H "Content-Type: application/json" \
  -d '{
    "name": "config-processor",
    "version": "0.9.0",
    "runtime": "lua",
    "capabilities": ["parse", "validate", "transform"]
  }'

Lua plugins provide lightweight scripting with minimal overhead, ideal for configuration processing and rules engines.

Request Body

name

string

required

Unique identifier for the plugin

version

string

required

Semantic version string (e.g., “1.0.0”)

runtime

string

required

Runtime type: wasm, python, js, or lua

capabilities

array

required

Array of capability strings the plugin provides

Response

Returns the registered plugin manifest object.

name

string

The registered plugin name

version

string

The plugin version

runtime

string

The plugin runtime type

capabilities

array

The plugin capabilities

Example Response

{
  "name": "wasm-processor",
  "version": "1.0.0",
  "runtime": "wasm",
  "capabilities": ["compute", "transform", "analyze"]
}

Plugin System Architecture

The QIMEM plugin system allows you to:

Extend Functionality: Add custom processing logic without modifying core platform code
Choose Your Runtime: Select the best runtime for your use case (performance, ecosystem, ease of development)
Declare Capabilities: Explicitly define what your plugin can do for discovery and validation
Version Management: Track plugin versions and manage compatibility

Common Capabilities

Data Processing: transform, filter, aggregate, validate
Authentication: oauth2, saml, ldap, mfa
Storage: read, write, index, search
Compute: analyze, predict, classify, score
Integration: webhook, api, event, stream

Best Practices

Use semantic versioning for your plugins
Keep capability names descriptive and consistent
Document plugin requirements and dependencies
Test plugins in isolation before platform deployment
Consider runtime performance characteristics when choosing between WASM, Python, JS, or Lua

Overview

Security APIs

Auth APIs

Plugin APIs

Overview

Plugin Manifest Structure

List Plugin Manifests

Response

Example Response

Register Plugin Manifest

Request Body

Response

Example Response

Plugin System Architecture

Common Capabilities

Best Practices

Build docs developers (and LLMs) love

Overview

Security APIs

Auth APIs

Plugin APIs

​Overview

​Plugin Manifest Structure

​List Plugin Manifests

​Response

​Example Response

​Register Plugin Manifest

​Request Body

​Response

​Example Response

​Plugin System Architecture

​Common Capabilities

​Best Practices

Build docs developers (and LLMs) love

Overview

Plugin Manifest Structure

List Plugin Manifests

Response

Example Response

Register Plugin Manifest

Request Body

Response

Example Response

Plugin System Architecture

Common Capabilities

Best Practices