Skip to content

插件

插件安装和管理操作


获取所有插件

GET
/api/v1/plugins

获取已安装的所有插件列表

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

响应

成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"plugins": [
{
}
]
}
}

试验场

服务器
授权

示例


获取插件详情

GET
/api/v1/plugins/{author}/{plugin_name}

获取指定插件的详细信息

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

author*

插件作者

类型string
必填
plugin_name*

插件名称

类型string
必填

响应

成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"plugin": {
}
}
}

试验场

服务器
授权
变量

示例


删除插件

DELETE
/api/v1/plugins/{author}/{plugin_name}

卸载指定的插件

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

author*

插件作者

类型string
必填
plugin_name*

插件名称

类型string
必填

查询参数

delete_data

是否删除插件数据

类型boolean
默认false

响应

删除任务已创建

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"task_id": "string"
}
}

试验场

服务器
授权
变量

示例


从本地文件安装插件

POST
/api/v1/plugins/install/local

上传并安装插件包文件

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

请求体

multipart/form-data
object

插件包文件(.lbpkg 格式)

格式"binary"

响应

安装任务已创建

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"task_id": "string"
}
}

试验场

服务器
授权
主体

示例


从 GitHub 安装插件

POST
/api/v1/plugins/install/github

从 GitHub Release 安装插件

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

请求体

application/json
JSON
{
"asset_url": "string",
"owner": "string",
"repo": "string",
"release_tag": "string"
}

响应

安装任务已创建

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"task_id": "string"
}
}

试验场

服务器
授权
主体

示例


从插件市场安装

POST
/api/v1/plugins/install/marketplace

从 LangBot 插件市场安装插件

授权

BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

请求体

application/json
JSON
{
"plugin_id": "string"
}

响应

安装任务已创建

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"task_id": "string"
}
}

试验场

服务器
授权
主体

示例


技术支持 VitePress OpenAPI