Execute a plugin and receive the sanitized result

Development Documentation

You're viewing documentation for unreleased features from the main branch. For production use, see the latest stable version (v1.1.x).

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.

POST
/api/v1/plugins/{plugin_id}/call
AuthorizationBearer <token>

In: header

Path Parameters

plugin_idstring

The unique identifier of the plugin

paramsunknown

Plugin parameters

Response Body

curl -X POST "https://loading/api/v1/plugins/string/call" \  -H "Content-Type: application/json" \  -d '{    "params": null  }'
{
  "data": "done!",
  "error": null,
  "metadata": {
    "logs": [
      {
        "level": "info",
        "message": "Plugin started..."
      }
    ],
    "traces": [
      {
        "method": "sendTransaction",
        "relayerId": "sepolia-example",
        "requestId": "6c1f336f-3030-4f90-bd99-ada190a1235b"
      }
    ]
  },
  "success": true
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "details": {
      "field": "email"
    }
  },
  "error": "Validation failed",
  "metadata": {
    "logs": [
      {
        "level": "error",
        "message": "Validation failed for field: email"
      }
    ]
  },
  "success": false
}
{
  "data": null,
  "error": "Unauthorized",
  "success": false
}
{
  "data": null,
  "error": "Plugin with ID plugin_id not found",
  "success": false
}
{
  "data": null,
  "error": "Too Many Requests",
  "success": false
}
{
  "data": null,
  "error": "Internal Server Error",
  "success": false
}