Create a new plugin

Creates a new plugin with the specified configuration.

POST /api/plugins

Error

A valid request URL is required to generate request examples

201

{
  "message": "<string>",
  "plugin": {
    "name": "my_custom_plugin",
    "actualName": "MyCustomPlugin",
    "enabled": true,
    "config": {
      "api_key": "xxx"
    },
    "isCustom": true,
    "path": "/plugins/my_custom_plugin.so",
    "status": {
      "name": "my_custom_plugin",
      "status": "active",
      "logs": [
        "plugin my_custom_plugin initialized successfully"
      ],
      "types": [
        "llm",
        "http"
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Body

application/json

Create plugin request

name · string · required

enabled · boolean

config · object

path · string

Response

201

application/json

Plugin created successfully

Plugin operation response

message · string

plugin · object

Plugin configuration

Show child attributes

Example:

{
  "name": "my_custom_plugin",
  "actualName": "MyCustomPlugin",
  "enabled": true,
  "config": { "api_key": "xxx" },
  "isCustom": true,
  "path": "/plugins/my_custom_plugin.so",
  "status": {
    "name": "my_custom_plugin",
    "status": "active",
    "logs": [
      "plugin my_custom_plugin initialized successfully"
    ],
    "types": ["llm", "http"]
  }
}