v18

latestOpenAPI 3.1.0AGPL-3.0 licenseraw.githubusercontent.com2026-08-0143162294.8 KB
Plugins

Execute a plugin with optional wildcard route routing

Logs and traces are only returned when the plugin is configured with emit_logs / emit_traces. Plugin-provided errors are normalized into a consistent payload (code, details) and a derived message so downstream clients receive a stable shape regardless of how the handler threw.

The endpoint supports wildcard route routing, allowing plugins to implement custom routing logic:

  • /api/v1/plugins/{plugin_id}/call - Default endpoint (route = "")
  • /api/v1/plugins/{plugin_id}/call?route=/verify - Custom route via query parameter
  • /api/v1/plugins/{plugin_id}/call/verify - Custom route via URL path (route = "/verify")

The route is passed to the plugin handler via the context.route field. You can specify a custom route either by appending it to the URL path or by using the route query parameter.

post/api/v1/plugins/{plugin_id}/call

Path parameters

plugin_idstring required

The unique identifier of the plugin

Query parameters

routestring

Optional route suffix for custom routing (e.g., '/verify'). Alternative to appending the route to the URL path.

Request body

{"stackTrail":"components:schemas:PluginCallRequest:properties:params","oasType":"schema","type":"unknown","description":"Plugin parameters. If not provided, the entire request body will be used as params."}

Response

Plugin call successful

{"stackTrail":"components:schemas:ApiResponse_Value:properties:data","oasType":"schema","type":"unknown"}
errorstring
successboolean required