Skip to main content
POST
/
api
/
plugins
Create a new plugin
curl --request POST \
  --url http://localhost:8080/api/plugins \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enabled": true,
  "config": {},
  "path": "<string>"
}
'
{
  "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"
      ]
    }
  }
}

Body

application/json

Create plugin request

​
name
string
required
​
enabled
boolean
​
config
object
​
path
string

Response

Plugin created successfully

Plugin operation response

​
message
string
​
plugin
object

Plugin configuration

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"]
  }
}