Plugin Endpoints

AeorDB supports deploying WebAssembly (WASM) plugins that extend the database with custom logic. Plugins are identified by name under the /plugins namespace.

Native Parsers

AeorDB includes 8 built-in format parsers that run automatically during indexing – no WASM deployment needed. Native parsers are tried first; if the content type is not recognized, the engine falls through to any deployed WASM parser plugin.

Supported Formats

How Native Parsers Work

1. When a file is stored and indexing runs, the engine checks the file’s content type against the native parser registry.
2. If the content type is application/octet-stream or empty, the engine falls back to extension-based matching.
3. If a native parser handles the format, it returns structured JSON that feeds into the indexing pipeline.
4. If no native parser matches, the engine falls through to the WASM plugin system (checking /.config/parsers.json or the directory’s parser field).

Native parsers have zero overhead compared to WASM – they run as compiled Rust code in the same process. WASM parser plugins remain available for custom or proprietary formats not covered by the built-in parsers.

Endpoint Summary

PUT /plugins/

Deploy a WASM plugin with the given name. If a plugin already exists with this name, it is replaced.

Request

• URL parameters:
  • {name} – plugin name
• Query parameters:
  • name (optional) – override the plugin name (defaults to the {name} URL segment)
  • plugin_type (optional) – plugin type string (defaults to "wasm")
• Headers:
  • Authorization: Bearer <token> (required)
• Body: raw WASM binary bytes

Response

Status: 200 OK

Returns the plugin metadata:

{
  "name": "my-plugin",
  "path": "my-plugin",
  "plugin_type": "wasm",
  "deployed_at": "2026-04-13T10:00:00Z"
}

Example

curl -X PUT "http://localhost:6830/plugins/my-plugin" \
  -H "Authorization: Bearer $TOKEN" \
  --data-binary @plugin.wasm

Error Responses

POST /plugins/{name}/invoke

Invoke a deployed plugin. The request body is wrapped in a PluginRequest envelope with metadata, then passed to the WASM runtime.

Request

• URL parameters:
  • {name} – plugin name
• Headers:
  • Authorization: Bearer <token> (required)
  • Content-Type – depends on what the plugin expects
• Body: raw request payload (passed to the plugin as arguments)

Plugin Request Envelope

The server wraps the raw body into:

{
  "arguments": "<raw body bytes>",
  "metadata": {
    "name": "my-plugin",
    "path": "/plugins/my-plugin",
    "plugin_path": "my-plugin"
  }
}

Plugin Response

Plugins return a PluginResponse envelope:

{
  "status_code": 200,
  "content_type": "application/json",
  "headers": {
    "x-custom-header": "value"
  },
  "body": "<response bytes>"
}

The server maps these fields to the HTTP response. For security, only safe headers are forwarded:

• Headers starting with x-
• cache-control, etag, last-modified, content-disposition, content-language, content-encoding, vary

If the plugin returns data that is not a valid PluginResponse, it is sent as raw application/octet-stream bytes (backward compatibility).

WASM Host Functions

Plugins have access to the following host functions for interacting with the database:

• CRUD: read, write, and delete files
• Query: execute queries and aggregations against the engine
• Context: access request metadata

Example

curl -X POST http://localhost:6830/plugins/my-plugin/invoke \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"input": "hello"}'

Error Responses

GET /plugins

List all deployed plugins.

Request

• Headers:
  • Authorization: Bearer <token> (required)

Response

Status: 200 OK

{
  "items": [
    {
      "name": "my-plugin",
      "path": "my-plugin",
      "plugin_type": "wasm"
    }
  ]
}

Example

curl http://localhost:6830/plugins \
  -H "Authorization: Bearer $TOKEN"

DELETE /plugins/

Remove a deployed plugin.

Request

• URL parameters:
  • {name} – plugin name
• Headers:
  • Authorization: Bearer <token> (required)

Response

Status: 200 OK

{
  "removed": true,
  "path": "my-plugin"
}

Example

curl -X DELETE http://localhost:6830/plugins/my-plugin \
  -H "Authorization: Bearer $TOKEN"

Error Responses