HomeForumWebsiteImpact
GitHub Icon
RelayerAPI ReferencePlugins

Execute a plugin via GET (must be enabled per plugin)

Outdated Version

You're viewing an older version (v1.5.x). The latest documentation is available for the current version. Click here to visit latest version.
AnthropicOpen in Claude

This endpoint is disabled by default. To enable it for a given plugin, set allow_get_invocation: true in the plugin configuration.

When invoked via GET:

  • params is an empty object ({})
  • query parameters are passed to the plugin handler via context.query
  • wildcard route routing is supported the same way as POST (see doc_call_plugin)
  • Use the route query parameter or append the route to the URL path
GET
/api/v1/plugins/{plugin_id}/call

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

plugin_idstring

The unique identifier of the plugin

Query Parameters

route?string

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

Response Body

curl -X GET "https://loading/api/v1/plugins/string/call?route=string"
{
  "data": null,
  "error": "string",
  "metadata": {
    "logs": [
      {
        "level": "log",
        "message": "string"
      }
    ],
    "traces": [
      null
    ]
  },
  "pagination": {
    "current_page": 0,
    "per_page": 0,
    "total_items": 0
  },
  "success": true
}
{
  "data": null,
  "error": "Unauthorized",
  "success": false
}
{
  "data": null,
  "error": "Plugin with ID plugin_id not found",
  "success": false
}
{
  "data": null,
  "error": "GET requests are not enabled for this plugin. Set 'allow_get_invocation: true' in plugin configuration to enable.",
  "success": false
}
{
  "data": null,
  "error": "Too Many Requests",
  "success": false
}
{
  "data": null,
  "error": "Internal Server Error",
  "success": false
}