- logs
- stats
- system
- settings
- plugins
- user
- provider
- pipelines
- platform
- files
- knowledge
获取可用的适配器列表
测试中
GET
/api/v1/platform/adapters
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/platform/adapters'
返回响应
🟢200成功
application/json
Body
object {0}
示例
{
"code": 0,
"data": {
"adapters": [
{
"description": {
"en_US": "Discord Adapter",
"zh_CN": "Discord 适配器,请查看文档了解使用方式"
},
"icon": "discord.svg",
"label": {
"en_US": "Discord",
"zh_CN": "Discord"
},
"name": "discord",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "Client ID",
"zh_CN": "客户端ID"
},
"name": "client_id",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "QQ Official API (Webhook)",
"zh_CN": "QQ 官方 API (Webhook),请查看文档了解使用方式"
},
"icon": "qqofficial.svg",
"label": {
"en_US": "QQ Official API",
"zh_CN": "QQ 官方 API"
},
"name": "qqofficial",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "App ID",
"zh_CN": "应用ID"
},
"name": "appid",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Secret",
"zh_CN": "密钥"
},
"name": "secret",
"required": true,
"type": "string"
},
{
"default": 2284,
"label": {
"en_US": "Port",
"zh_CN": "监听端口"
},
"name": "port",
"required": true,
"type": "integer"
},
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "Telegram Adapter",
"zh_CN": "电报适配器,请查看文档了解使用方式"
},
"icon": "telegram.svg",
"label": {
"en_US": "Telegram",
"zh_CN": "电报"
},
"name": "telegram",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "WeCom Adapter",
"zh_CN": "企业微信适配器,请查看文档了解使用方式"
},
"icon": "wecom.png",
"label": {
"en_US": "WeCom",
"zh_CN": "企业微信"
},
"name": "wecom",
"spec": {
"config": [
{
"default": "0.0.0.0",
"description": {
"en_US": "Webhook host, unless you know what you're doing, please write 0.0.0.0",
"zh_CN": "Webhook 监听主机,除非你知道自己在做什么,否则请写 0.0.0.0"
},
"label": {
"en_US": "Host",
"zh_CN": "监听主机"
},
"name": "host",
"required": true,
"type": "string"
},
{
"default": 2290,
"label": {
"en_US": "Port",
"zh_CN": "监听端口"
},
"name": "port",
"required": true,
"type": "integer"
},
{
"default": "",
"label": {
"en_US": "Corpid",
"zh_CN": "企业ID"
},
"name": "corpid",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Secret",
"zh_CN": "密钥"
},
"name": "secret",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "EncodingAESKey",
"zh_CN": "消息加解密密钥"
},
"name": "EncodingAESKey",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Contacts Secret",
"zh_CN": "通讯录密钥"
},
"name": "contacts_secret",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "GeWeChat Adapter",
"zh_CN": "GeWeChat 适配器,请查看文档了解使用方式"
},
"icon": "gewechat.png",
"label": {
"en_US": "GeWeChat",
"zh_CN": "GeWeChat(个人微信)"
},
"name": "gewechat",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "GeWeChat URL",
"zh_CN": "GeWeChat URL"
},
"name": "gewechat_url",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "GeWeChat file download URL",
"zh_CN": "GeWeChat 文件下载URL"
},
"name": "gewechat_file_url",
"required": true,
"type": "string"
},
{
"default": 2286,
"label": {
"en_US": "Port",
"zh_CN": "端口"
},
"name": "port",
"required": true,
"type": "integer"
},
{
"default": "",
"label": {
"en_US": "Callback URL",
"zh_CN": "回调URL"
},
"name": "callback_url",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "App ID",
"zh_CN": "应用ID"
},
"name": "app_id",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "OneBot v11 Adapter",
"zh_CN": "OneBot v11 适配器,请查看文档了解使用方式"
},
"icon": "onebot.png",
"label": {
"en_US": "OneBot v11 Adapter",
"zh_CN": "OneBot v11 适配器"
},
"name": "aiocqhttp",
"spec": {
"config": [
{
"default": "0.0.0.0",
"description": {
"en_US": "The host that OneBot v11 listens on for reverse WebSocket connections. Unless you know what you're doing, use 0.0.0.0",
"zh_CN": "OneBot v11 监听的反向 WS 主机,除非你知道自己在做什么,否则请写 0.0.0.0"
},
"label": {
"en_US": "Host",
"zh_CN": "主机"
},
"name": "host",
"required": true,
"type": "string"
},
{
"default": 2280,
"description": {
"en_US": "Port",
"zh_CN": "监听的端口"
},
"label": {
"en_US": "Port",
"zh_CN": "端口"
},
"name": "port",
"required": true,
"type": "integer"
},
{
"default": "",
"description": {
"en_US": "Custom connection token for the protocol endpoint. If the protocol endpoint is not set, don't fill it",
"zh_CN": "自定义的与协议端的连接令牌,若协议端未设置,则不填"
},
"label": {
"en_US": "Access Token",
"zh_CN": "访问令牌"
},
"name": "access-token",
"required": false,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "Official Account Adapter",
"zh_CN": "微信公众号适配器,请查看文档了解使用方式"
},
"icon": "officialaccount.png",
"label": {
"en_US": "Official Account",
"zh_CN": "微信公众号"
},
"name": "officialaccount",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "EncodingAESKey",
"zh_CN": "消息加解密密钥"
},
"name": "EncodingAESKey",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "App ID",
"zh_CN": "应用ID"
},
"name": "AppID",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "App Secret",
"zh_CN": "应用密钥"
},
"name": "AppSecret",
"required": true,
"type": "string"
},
{
"default": "0.0.0.0",
"label": {
"en_US": "Host",
"zh_CN": "监听主机"
},
"name": "host",
"required": true,
"type": "string"
},
{
"default": 2287,
"label": {
"en_US": "Port",
"zh_CN": "监听端口"
},
"name": "port",
"required": true,
"type": "integer"
}
]
}
},
{
"description": {
"en_US": "Nakuru Adapter",
"zh_CN": "Nakuru 适配器(go-cqhttp),请查看文档了解使用方式"
},
"icon": "nakuru.png",
"label": {
"en_US": "Nakuru",
"zh_CN": "Nakuru"
},
"name": "nakuru",
"spec": {
"config": [
{
"default": "127.0.0.1",
"label": {
"en_US": "Host",
"zh_CN": "主机"
},
"name": "host",
"required": true,
"type": "string"
},
{
"default": 5700,
"label": {
"en_US": "HTTP Port",
"zh_CN": "HTTP端口"
},
"name": "http_port",
"required": true,
"type": "integer"
},
{
"default": 8080,
"label": {
"en_US": "WebSocket Port",
"zh_CN": "WebSocket端口"
},
"name": "ws_port",
"required": true,
"type": "integer"
},
{
"default": "",
"label": {
"en_US": "Token",
"zh_CN": "令牌"
},
"name": "token",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "QQ Official API (WebSocket)",
"zh_CN": "QQ 官方 API (WebSocket),请查看文档了解使用方式"
},
"icon": "qqbotpy.svg",
"label": {
"en_US": "QQBotPy",
"zh_CN": "QQBotPy"
},
"name": "qq-botpy",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "App ID",
"zh_CN": "应用ID"
},
"name": "appid",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Secret",
"zh_CN": "密钥"
},
"name": "secret",
"required": true,
"type": "string"
},
{
"default": [],
"items": {
"type": "string"
},
"label": {
"en_US": "Intents",
"zh_CN": "权限"
},
"name": "intents",
"required": true,
"type": "array"
}
]
}
},
{
"description": {
"en_US": "DingTalk Adapter",
"zh_CN": "钉钉适配器,请查看文档了解使用方式"
},
"icon": "dingtalk.svg",
"label": {
"en_US": "DingTalk",
"zh_CN": "钉钉"
},
"name": "dingtalk",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "Client ID",
"zh_CN": "客户端ID"
},
"name": "client_id",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Client Secret",
"zh_CN": "客户端密钥"
},
"name": "client_secret",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Robot Code",
"zh_CN": "机器人代码"
},
"name": "robot_code",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Robot Name",
"zh_CN": "机器人名称"
},
"name": "robot_name",
"required": true,
"type": "string"
}
]
}
},
{
"description": {
"en_US": "Lark Adapter",
"zh_CN": "飞书适配器,请查看文档了解使用方式"
},
"icon": "lark.svg",
"label": {
"en_US": "Lark",
"zh_CN": "飞书"
},
"name": "lark",
"spec": {
"config": [
{
"default": "",
"label": {
"en_US": "App ID",
"zh_CN": "应用ID"
},
"name": "app_id",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "App Secret",
"zh_CN": "应用密钥"
},
"name": "app_secret",
"required": true,
"type": "string"
},
{
"default": "",
"label": {
"en_US": "Bot Name",
"zh_CN": "机器人名称"
},
"name": "bot_name",
"required": true,
"type": "string"
},
{
"default": false,
"description": {
"en_US": "If enabled, the bot will use webhook mode to receive messages. Otherwise, it will use WS long connection mode",
"zh_CN": "如果启用,机器人将使用 Webhook 模式接收消息。否则,将使用 WS 长连接模式"
},
"label": {
"en_US": "Enable Webhook Mode",
"zh_CN": "启用Webhook模式"
},
"name": "enable-webhook",
"required": true,
"type": "boolean"
},
{
"default": 2285,
"description": {
"en_US": "Only valid when webhook mode is enabled, please fill in the webhook port",
"zh_CN": "仅在启用 Webhook 模式时有效,请填写 Webhook 端口"
},
"label": {
"en_US": "Webhook Port",
"zh_CN": "Webhook端口"
},
"name": "port",
"required": true,
"type": "integer"
},
{
"default": "",
"description": {
"en_US": "Only valid when webhook mode is enabled, please fill in the encrypt key",
"zh_CN": "仅在启用 Webhook 模式时有效,请填写加密密钥"
},
"label": {
"en_US": "Encrypt Key",
"zh_CN": "加密密钥"
},
"name": "encrypt-key",
"required": true,
"type": "string"
}
]
}
}
]
},
"msg": "ok"
}
修改于 2025-03-26 16:55:28