Skip to content

机器人

机器人实例管理操作


列出所有机器人

GET
/api/v1/platform/bots

获取所有已配置的机器人实例列表

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

响应

成功响应

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"bots": [
{
"uuid": "string",
"name": "string",
"adapter": "telegram",
"config": {
},
"created_at": "string",
"updated_at": "string"
}
]
}
}

试验场

服务器
授权

示例


创建新的机器人

POST
/api/v1/platform/bots

创建并配置一个新的机器人实例

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

请求体

application/json
JSON
{
"name": "string",
"adapter": "string",
"config": {
}
}

响应

机器人创建成功

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

试验场

服务器
授权
主体

示例


获取指定的机器人

GET
/api/v1/platform/bots/{bot_uuid}

获取指定机器人实例的详细信息

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

参数

路径参数

bot_uuid*

机器人 UUID

类型string
必填
格式"uuid"

响应

成功响应

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"bot": {
"uuid": "string",
"name": "string",
"adapter": "telegram",
"config": {
},
"created_at": "string",
"updated_at": "string"
}
}
}

试验场

服务器
授权
变量

示例


更新机器人

PUT
/api/v1/platform/bots/{bot_uuid}

更新现有机器人实例的配置

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

参数

路径参数

bot_uuid*
类型string
必填
格式"uuid"

请求体

application/json
JSON
{
"name": "string",
"config": {
}
}

响应

机器人更新成功

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

试验场

服务器
授权
变量
主体

示例


删除机器人

DELETE
/api/v1/platform/bots/{bot_uuid}

从系统中删除一个机器人实例

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

参数

路径参数

bot_uuid*
类型string
必填
格式"uuid"

响应

机器人删除成功

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

试验场

服务器
授权
变量

示例


获取机器人事件日志

POST
/api/v1/platform/bots/{bot_uuid}/logs

获取指定机器人的事件日志

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

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

类型HTTP (bearer)

参数

路径参数

bot_uuid*
类型string
必填
格式"uuid"

请求体

application/json
JSON
{
"from_index": -1,
"max_count": 10
}

响应

成功响应

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

试验场

服务器
授权
变量
主体

示例


发送消息

POST
/api/v1/platform/bots/{bot_uuid}/send_message

通过指定机器人向指定目标发送消息

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)

参数

路径参数

bot_uuid*

机器人 UUID

类型string
必填

请求体

application/json
JSON
{
"target_type": "group",
"target_id": "123456789",
"message_chain": [
{
"type": "Plain",
"text": "Hello, World!"
}
]
}

响应

发送成功

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

试验场

服务器
授权
变量
主体

示例


技术支持 VitePress OpenAPI