AI 管理 | XSwitch文档中心

AI 机器人

获取 AI 机器人列表

请求 URL： /api/ai_robot
请求方式： GET
示例： GET /api/ai_robot?page=1&perPage=500
Body 信息：无
返回值：

{
	"rowCount":	1,
	"pageCount":	1,
	"page":	1,
	"data":	[{
			"domain":	"xswitch.cn",
			"description":	"",
			"data":	"{\"kb\": {}, \"asr\": {\"engine\": \"ali\", \"language\": \"zh_CN\"}, \"llm\": {\"id\": 8, \"model\": \"gpt-4o-mini\", \"token\": \"x\", \"base_url\": \"https://api.lkeap.cloud.tencent.com/v1\", \"model_id\": 3830, \"kb_enable\": false, \"qa_enable\": false, \"kb_threshold\": 0.7, \"service_provider\": \"TencentCloud\", \"kb_unmatch_message\": \"抱歉，我还在学习中，无法回答这个问题\", \"function_call_enable\": false, \"function_call_transfer\": false}, \"tts\": {\"voice\": \"default\", \"engine\": \"ali\"}, \"beep\": false, \"name\": \"AI robot\", \"texts\": {\"hello_text\": \"您好？\", \"goodbye_text\": [\"再见\", \"拜拜\", \"bye\"], \"init_prompts\": \"你是一名AI客服助理。\", \"init_welcome_text\": \"您好，有什么可以帮您\"}, \"call_fwd\": false, \"break_mode\": true, \"description\": \"test\", \"enable_record\": false, \"transfer_context\": {}, \"no_speaking_timeout\": \"8\"}",
			"deleted_at":	"",
			"updated_at":	"2026-04-30 03:14:01",
			"created_at":	"2026-04-30 03:14:01",
			"override":	"{}",
			"name":	"AI robot",
			"uuid":	"0a7fb0d0-3d8e-49ff-823d-e91802a3c01e"
		}]
}

返回值参数说明：

参数	说明
created_at	创建时间
description	描述
domain	域名
uuid	唯一标识 UUID
deleted_at	删除时间
updated_at	更新时间
name	名称
data	核心配置数据
kb	知识库配置
asr.model	ASR模型
asr.engine	ASR引擎
asr.language	ASR语言
llm.id	大模型ID
llm.model	大模型设置
llm.token	调用令牌
llm.base_url	接口地址
llm.model_id	模型ID
llm.kb_enable	是否启用知识库
llm.qa_enable	是否启用问答匹配
llm.kb_threshold	知识库匹配阈值
llm.service_provider	模型服务商
llm.kb_unmatch_message	无匹配答案提示语
tts.voice	TTS音色
tts.engine	TTS引擎
beep	是否开启提示音
texts.hello_text	问候语
texts.goodbye_text	结束语
texts.init_prompts	系统提示词
texts.init_welcome_text	欢迎语
call_fwd	是否开启呼叫转接
break_mode	是否开启打断
enable_record	是否开启录音
no_speaking_timeout	无语音超时时间

获取指定 AI 机器人详情

请求 URL： /api/ai_robot/:uuid
请求方式： GET
示例： GET /api/ai_robot/0a7fb0d0-3d8e-49ff-823d-e91802a3c01e
Body 信息：无
返回值：

{
	"code":	200,
	"message":	"success",
	"data":	[{
			"deleted_at":	"",
			"name":	"AI robot",
			"uuid":	"0a7fb0d0-3d8e-49ff-823d-e91802a3c01e",
			"created_at":	"2026-04-30 03:14:01",
			"domain":	"xswitch.cn",
			"updated_at":	"2026-04-30 03:14:01",
			"override":	[],
			"description":	"",
			"data":	{
				"asr":	{
					"engine":	"ali",
					"language":	"zh_CN"
				},
				"kb":	[],
				"texts":	{
					"init_prompts":	"你是一名AI客服助理。",
					"hello_text":	"您好？",
					"init_welcome_text":	"您好，有什么可以帮您",
					"goodbye_text":	["再见", "拜拜", "bye"]
				},
				"name":	"AI robot",
				"call_fwd":	false,
				"enable_record":	false,
				"no_speaking_timeout":	"8",
				"llm":	{
					"base_url":	"https://api.lkeap.cloud.tencent.com/v1",
					"id":	8,
					"function_call_transfer":	false,
					"kb_enable":	false,
					"model":	"gpt-4o-mini",
					"model_id":	3830,
					"function_call_enable":	false,
					"kb_unmatch_message":	"抱歉，我还在学习中，无法回答这个问题",
					"qa_answer_opt":	false,
					"service_provider":	"TencentCloud",
					"qa_enable":	false,
					"token":	"x",
					"kb_threshold":	0.7,
					"gpt-4o-mini":	"gpt-4o-mini",
					"kb":	[]
				},
				"transfer_context":	[],
				"domain":	"xswitch.cn",
				"beep":	false,
				"tts":	{
					"voice":	"default",
					"engine":	"ali"
				},
				"description":	"",
				"break_mode":	true
			}
		}]
}

返回值参数说明：

参数	说明
created_at	创建时间
description	描述
domain	域名
uuid	唯一标识 UUID
deleted_at	删除时间
updated_at	更新时间
name	名称
data	核心配置数据
kb	知识库配置
asr.model	ASR模型
asr.engine	ASR引擎
asr.language	ASR语言
llm.id	大模型ID
llm.model	大模型设置
llm.token	调用令牌
llm.base_url	接口地址
llm.model_id	模型ID
llm.kb_enable	是否启用知识库
llm.qa_enable	是否启用问答匹配
llm.kb_threshold	知识库匹配阈值
llm.service_provider	模型服务商
llm.kb_unmatch_message	无匹配答案提示语
tts.voice	TTS音色
tts.engine	TTS引擎
beep	是否开启提示音
texts.hello_text	问候语
texts.goodbye_text	结束语
texts.init_prompts	系统提示词
texts.init_welcome_text	欢迎语
call_fwd	是否开启呼叫转接
break_mode	是否开启打断
enable_record	是否开启录音
no_speaking_timeout	无语音超时时间

获取指定 AI 机器人关联路由

请求 URL： /api/ai_robot/:uuid/routes
请求方式：GET
示例：GET /api/ai_robot/0a7fb0d0-3d8e-49ff-823d-e91802a3c01e/routes
Body 信息：无
返回值：

[
	{
		"name": "AI robot",
		"dnc": "",
		"dest_type": "FS_DEST_CHATGPT",
		"bill_out_info": "",
		"ringback_enabled": "0",
		"bill_rate_id": "",
		"body": "",
		"sdnc": "",
		"auto_record": "0",
		"cid_number": "",
		"updated_at": "2026-04-30 05:46:19",
		"route_type": "4",
		"created_at": "2026-04-30 05:46:19",
		"ringback_tone": "",
		"media_codec": "",
		"disabled": "0",
		"max_length": "4",
		"context": "context-1",
		"bill_in_info": "",
		"proxy_media": "1",
		"description": "test",
		"id": "27",
		"did_enabled": "0",
		"blacklist": "",
		"prefix": "1111",
		"force_video_recording": "0",
		"deleted_at": "",
		"dest_uuid": "0a7fb0d0-3d8e-49ff-823d-e91802a3c01e"
	}
]

返回值参数说明：

参数	说明
name	名称
dnc	主叫号码限制配置
dest_type	目标路由类型
bill_out_info	呼出计费信息
ringback_enabled	是否启用回铃音
bill_rate_id	计费费率ID
body	自定义内容
sdnc	被叫号码限制配置
auto_record	是否自动录音
cid_number	来电显示号码
updated_at	更新时间
route_type	路由类型
created_at	创建时间
ringback_tone	回铃音资源地址
media_codec	媒体编码格式
disabled	是否禁用
max_length	最大号码长度
context	呼叫源
bill_in_info	呼入计费信息
proxy_media	是否媒体代理
description	描述
id	ID
did_enabled	是否启用DID
blacklist	黑白名单配置
prefix	号码前缀
force_video_recording	是否强制视频录音
deleted_at	删除时间
dest_uuid	目标AI机器人UUID

新建 AI 机器人

请求 URL： /api/ai_robot
请求方式：POST
Body 信息：

参数	说明
name	名称
description	描述
kb	知识库配置
no_speaking_timeout	无语音超时时间
break_mode	是否开启打断模式
enable_record	是否开启录音
beep	是否开启提示音
call_fwd	是否开启呼叫转接
tts.engine	TTS引擎
tts.voice	TTS音色
asr.engine	ASR引擎
asr.language	ASR语言
llm.id	大模型配置ID
llm.model_id	大模型ID
llm.service_provider	大模型服务商编号
llm.qa_enable	是否启用问答匹配
llm.function_call_enable	是否启用方法回调
llm.kb_unmatch_message	知识库无匹配提示语
llm.kb_threshold	知识库匹配阈值
llm.kb_enable	是否启用知识库
transfer_context	转接呼叫源
texts.hello_text	问候语文本
texts.init_prompts	AI系统提示词
texts.init_welcome_text	开场欢迎语
texts.goodbye_text	结束语
domain	域名

{
  "name": "AI_robot",
  "description": "AI机器人",
  "kb": [],
  "no_speaking_timeout": "8",
  "break_mode": true,
  "enable_record": false,
  "beep": false,
  "call_fwd": false,
  "tts": {
    "engine": "ali",
    "voice": "default"
  },
  "asr": {
    "engine": "ali",
    "language": "zh_CN"
  },
  "llm": {
    "id": 3823,
    "model_id": 3823,
    "service_provider": 2,
    "qa_enable": false,
    "function_call_enable": false,
    "kb_unmatch_message": "抱歉，我还在学习中，无法回答这个问题",
    "kb_threshold": 0.7,
    "kb_enable": false
  },
  "transfer_context": [],
  "texts": {
    "hello_text": "您好？",
    "init_prompts": "你是一名AI客服助理。",
    "init_welcome_text": "您好，有什么可以帮您",
    "goodbye_text": [
      "再见",
      "拜拜",
      "bye"
    ]
  },
  "domain": null
}

返回值：

{
	"data":	{
		"deleted_at":	"",
		"name":	"AI_robot",
		"created_at":	"2026-04-30 05:53:32",
		"uuid":	"5d34ddcd-9451-49cf-8b32-b2e5011a9327",
		"updated_at":	"2026-04-30 05:53:32",
		"data":	{
			"asr":	{
				"language":	"zh_CN",
				"engine":	"ali"
			},
			"name":	"AI_robot",
			"no_speaking_timeout":	"8",
			"call_fwd":	false,
			"transfer_context":	[],
			"beep":	false,
			"tts":	{
				"engine":	"ali",
				"voice":	"default"
			},
			"enable_record":	false,
			"kb":	[],
			"break_mode":	true,
			"llm":	{
				"model":	"gpt-4o-mini",
				"token":	"x",
				"qa_enable":	false,
				"function_call_transfer":	false,
				"function_call_enable":	false,
				"kb_enable":	false,
				"id":	2,
				"service_provider":	"DeepSeek",
				"base_url":	"https://api.deepseek.com/v1",
				"kb_threshold":	0.7,
				"model_id":	3823,
				"kb_unmatch_message":	"抱歉，我还在学习中，无法回答这个问题"
			},
			"texts":	{
				"goodbye_text":	["再见", "拜拜", "bye"],
				"init_welcome_text":	"您好，有什么可以帮您",
				"init_prompts":	"你是一名AI客服助理。",
				"hello_text":	"您好？"
			},
			"description":	"AI机器人"
		},
		"domain":	"xswitch.cn",
		"override":	[],
		"description":	""
	},
	"code":	200,
	"message":	"success"
}

修改指定 AI 机器人

请求 URL： /api/ai_robot/:uuid
请求方式：PUT
Body 信息：

参数	说明
name	名称
description	描述
kb	知识库配置
no_speaking_timeout	无语音超时时间
break_mode	是否开启打断模式
enable_record	是否开启录音
beep	是否开启提示音
call_fwd	是否开启呼叫转接
tts.engine	TTS引擎
tts.voice	TTS音色
asr.engine	ASR引擎
asr.language	ASR语言
llm.id	大模型配置ID
llm.model_id	大模型ID
llm.service_provider	大模型服务商编号
llm.qa_enable	是否启用问答匹配
llm.function_call_enable	是否启用方法回调
llm.kb_unmatch_message	知识库无匹配提示语
llm.kb_threshold	知识库匹配阈值
llm.kb_enable	是否启用知识库
transfer_context	转接呼叫源
texts.hello_text	问候语文本
texts.init_prompts	AI系统提示词
texts.init_welcome_text	开场欢迎语
texts.goodbye_text	结束语
domain	域名

{
  "transfer_context": [],
  "enable_record": false,
  "tts": {
    "voice": "default",
    "engine": "ali"
  },
  "name": "AI_robot",
  "asr": {
    "engine": "ali",
    "language": "zh_CN"
  },
  "description": "",
  "texts": {
    "init_welcome_text": "您好，有什么可以帮您",
    "hello_text": "您好？",
    "goodbye_text": [
      "再见",
      "拜拜",
      "bye"
    ],
    "init_prompts": "你是一名AI客服助理。"
  },
  "no_speaking_timeout": "8",
  "beep": false,
  "break_mode": true,
  "llm": {
    "qa_enable": false,
    "base_url": "https://api.deepseek.com/v1",
    "function_call_enable": true,
    "function_call_transfer": false,
    "kb_enable": false,
    "token": "x",
    "model": "gpt-4o-mini",
    "id": 2,
    "service_provider": "DeepSeek",
    "kb_threshold": 0.7,
    "kb_unmatch_message": "抱歉，我还在学习中，无法回答这个问题",
    "qa_answer_opt": false
  },
  "kb": [],
  "call_fwd": false,
  "domain": "xswitch.cn"
}

响应信息：

{
	"data":	"{}",
	"message":	"success",
	"code":	200
}

删除指定 AI 机器人

请求 URL： /api/ai_robot/:uuid
请求方式：DELETE
返回值：

{
	"uuid":	"7008553a-55ee-4db7-a45e-cbc93dc36d12"
}

返回值参数说明：

参数	说明
uuid	唯一标识UUID

大模型

新建大模型

请求 URL： /api/llm_profiles
请求方式：POST
Body 信息：

参数	说明
name	名称
type	类型
description	描述
template	模板
abilities	功能

{
  "name": "llm",
  "type": "CherryGPT",
  "description": "test",
  "template": 4,
  "abilities": [
    "REASONING"
  ]
}

返回值：

{
	"data":	"1",
	"code":	200,
	"message":	"success"
}

获取大模型列表

请求 URL： /api/llm_profiles
请求方式：GET
Body 信息：无
返回值：

[
	{
		"name": "OpenAI",
		"disabled": 0,
		"id": 1,
		"description": "",
		"type": "OpenAI",
		"updated_at": "2026-04-24 05:05:28",
		"deleted_at": "",
		"abilities": [
			"REASONING"
		],
		"created_at": "2026-04-24 05:05:28"
	}...
]

返回值参数说明：

参数	说明
name	名称
disabled	是否启用
id	ID
description	描述
type	类型
updated_at	更新时间
deleted_at	删除时间
abilities	功能
created_at	创建时间

获取指定大模型

请求 URL： /api/llm_profiles/:id
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：无
返回值：

{
	"params":	[{
			"k":	"base_url",
			"deleted_at":	"",
			"disabled":	"0",
			"updated_at":	"2025-12-09 09:09:28",
			"realm":	"LLM-SETTINGS",
			"ref_id":	"1",
			"v":	"https://api.openai.com/v1",
			"created_at":	"2025-12-09 09:09:28",
			"id":	"3461"
		}...],
	"description":	"",
	"deleted_at":	"",
	"disabled":	0,
	"abilities":	["REASONING"],
	"created_at":	"2025-12-09 09:09:09",
	"updated_at":	"2025-12-09 09:09:09",
	"type":	"OpenAI",
	"name":	"OpenAI",
	"id":	1
}

返回值参数说明：

参数	说明
id	ID
name	名称
type	类型
description	描述
disabled	是否启用
abilities	功能
created_at	创建时间
updated_at	更新时间
deleted_at	删除时间
params	配置参数
k	键
v	值
realm	域
ref_id	关联ID

修改指定大模型

请求 URL： /api/llm_profiles/:id
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：

参数	说明
id	ID
name	名称
type	类型
description	描述
abilities	功能

{
	"name":"OpenAI",
	"description":"OpenAI",
	"type":"OpenAI",
	"abilities":["REASONING"],
	"id":1
}

响应信息：

{
	"data":	"1",
	"code":	200,
	"message":	"success"
}

创建指定大模型参数

请求 URL： /api/llm_profiles/:id/params
请求方式：POST
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：

参数	说明
k	键
v	值
realm	域

{
	"k":"kkk",
	"v":"vvv",
	"realm":"LLM-SETTINGS"
}

响应信息：

{
	"code":	200,
	"data":	3536,
	"message":	"success"
}

修改指定大模型参数

请求 URL： /api/llm_profiles/:id/params/:param_id
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：

参数	说明
k	键
v	值
realm	域

{
	"k":"token",
	"v":"x",
	"realm":"LLM-SETTINGS"
}

响应信息：

{
	"code":	200,
	"data":	"3462",
	"message":	"success"
}

获取可用的 LLM 模型列表

请求 URL： /api/llm_profiles/models
请求方式：GET
Body 信息：无
返回值：

[
	{
		"name": "DeepSeek",
		"disabled": 0,
		"id": 2,
		"abilities": [
			"REASONING"
		],
		"type": "DeepSeek",
		"description": "",
		"updated_at": "2026-04-24 05:05:28",
		"created_at": "2026-04-24 05:05:28",
		"deleted_at": "",
		"params": [
			{
				"ref_id": 2,
				"disabled": 0,
				"updated_at": "2026-04-24T05:05:42",
				"k": "gpt-4o-mini",
				"id": 3823,
				"created_at": "2026-04-24T05:05:42",
				"v": "gpt-4o-mini",
				"realm": "LLM-MODELS"
			}
		]
	},...
]

返回值参数说明：

参数	说明
id	ID
name	名称
type	类型
description	描述
disabled	是否启用
abilities	功能
created_at	创建时间
updated_at	更新时间
deleted_at	删除时间
params	配置参数
k	键
v	值
realm	域
ref_id	关联ID

修改大模型启用状态

请求 URL： /api/llm_profiles/toggle/:id
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：

参数	说明
action	动作（是否开启）

{
	"action":"llm"
}

返回值：

{
	"code":	200,
	"message":	"success",
	"data":	[{
			"disabled":	1,
			"description":	"",
			"name":	"OpenAI",
			"deleted_at":	"",
			"type":	"OpenAI",
			"abilities":	["REASONING"],
			"created_at":	"2025-12-12 07:42:26",
			"updated_at":	"2025-12-12 07:42:26",
			"id":	1
		}, {
			"disabled":	0,
			"description":	"",
			"name":	"DeepSeek",
			"deleted_at":	"",
			"type":	"DeepSeek",
			"abilities":	["REASONING"],
			"created_at":	"2025-12-12 07:42:26",
			"updated_at":	"2025-12-12 07:42:26",
			"id":	2
		}
		...]
}

返回值参数说明：

参数	说明
id	ID
name	名称
type	类型
description	描述
disabled	是否启用
abilities	功能
created_at	创建时间
updated_at	更新时间
deleted_at	删除时间

删除指定大模型的参数

请求 URL： /api/llm_profiles/:id/params/:param_id
请求方式：DELETE
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID
param_id	int	是	参数 ID

Body 信息：无
响应信息：

{
	"data":	"1",
	"code":	200,
	"message":	"success"
}

删除指定大模型

请求 URL： /api/llm_profiles/:id
请求方式：DELETE
请求参数：

参数名	类型	是否必填	描述
id	int	是	大模型 ID

Body 信息：无
响应信息：

{
	"data":	"1",
	"code":	200,
	"message":	"success"
}

AI 知识库

获取 AI 知识库列表

请求 URL： /api/knowledge_bases/
请求方式：GET
Body 信息：无
返回值：

{
	"page":	1,
	"data":	[{
			"created_at":	"2025-12-09 06:25:21",
			"description":	"text",
			"id":	"49",
			"name":	"2",
			"data":	"{\"provider\": 6}",
			"deleted_at":	"",
			"updated_at":	"2025-12-09 06:25:21"
		}, {
			"created_at":	"2025-12-09 00:57:33",
			"description":	"",
			"id":	"48",
			"name":	"Test Knowledge Base",
			"data":	"{\"provider\": \"1\"}",
			"deleted_at":	"",
			"updated_at":	"2025-12-09 00:57:33"
		}],
	"rowCount":	2,
	"pageCount":	1
}

返回值参数说明：

参数	说明
id	ID
name	名称
data	数据配置
description	描述
created_at	创建时间
updated_at	更新时间
deleted_at	删除时间

获取指定 AI 知识库

请求 URL： /api/knowledge_bases/:id
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：无
返回值：

{
	"id":	49,
	"description":	"text",
	"created_at":	"2025-12-09 06:25:21",
	"name":	"2",
	"data":	{
		"provider":	6
	},
	"updated_at":	"2025-12-09 06:25:21",
	"deleted_at":	""
}

返回值参数说明：

参数	说明
id	ID
name	名称
data	数据配置
description	描述
created_at	创建时间
updated_at	更新时间
deleted_at	删除时间

获取指定 AI 知识库的问答对

请求 URL： /api/knowledge_bases/:id/qa/pairs
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：无
响应信息：

[
    {
        "id": "0f9fde90-c4f5-4bc7-a5b0-ef5f5ea595b1",
        "integration_id": "ollama",
        "external_user_id": null,
        "external_username": null,
        "question": "Can you help us set up a remote work system for employees?",
        "answer": "Yes. We can help deploy remote work tools (e.g., VPN configuration, cloud collaboration platforms like Microsoft Teams/Google Workspace), set up access permissions for employees, and test the system to ensure stable remote connection and data security.",
        "additional_questions": [],
        "attrs": {
            "file_id": "734",
            "memory_id": "f0a144e6-6666-48cd-95d5-38e9e5593037"
        },
        "status": "enabled",
        "created_at": "2025-12-05T07:19:16.022Z",
        "updated_at": null,
        "key": "89be75fd2e043dbea794fe34b6a3bbac"
    }
	......
]

返回值参数说明：

参数	说明
id	ID
integration_id	集成标识ID
external_user_id	外部用户ID
external_username	外部用户名
question	问题
answer	问题标准答案
additional_questions	关联补充问题列表
attrs	扩展属性
status	启用状态
created_at	创建时间
updated_at	更新时间
key	密钥

修改指定 AI 知识库问答对

请求 URL： /api/knowledge_bases/:id/qa/pairs/:qid
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID
qid	int	是	问答对 UUID

Body 信息：

参数	说明
question	问题
additional_questions	补充问题列表
answer	标准答案回复

{
	"question":"Can you help us set up a remote work system for employees?",
	"additional_questions":["- Can you assist with setting up a remote work environment for employees?  ",...],
	"answer":"Yes. We can help deploy remote work tools (e.g., VPN configuration, cloud collaboration platforms like Microsoft Teams/Google Workspace), set up access permissions for employees, and test the system to ensure stable remote connection and data security."
}

返回值：

{
    "id": "0f9fde90-c4f5-4bc7-a5b0-ef5f5ea595b1",
    "integration_id": "ollama",
    "external_user_id": null,
    "external_username": null,
    "question": "Can you help us set up a remote work system for employees?",
    "answer": "Yes. We can help deploy remote work tools (e.g., VPN configuration, cloud collaboration platforms like Microsoft Teams/Google Workspace), set up access permissions for employees, and test the system to ensure stable remote connection and data security.",
    "additional_questions": [
        "- Can you assist with setting up a remote work environment for employees?  ",
		......
    ],
    "attrs": null,
    "status": "enabled",
    "created_at": "2025-12-05T07:19:16.022Z",
    "updated_at": "2025-12-09T08:37:43.836Z",
    "key": "89be75fd2e043dbea794fe34b6a3bbac"
}

返回值参数说明：

参数	说明
id	ID
integration_id	集成标识ID
external_user_id	外部用户ID
external_username	外部用户名
question	问题
answer	问题标准答案
additional_questions	关联补充问题列表
attrs	扩展属性
status	启用状态
created_at	创建时间
updated_at	更新时间
key	密钥

删除指定 AI 知识库问答对

请求 URL： /api/knowledge_bases/:id/qa_pairs/:qid
请求方式：DELETE
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID
qid	int	是	问答对 UUID

Body 信息：无
响应信息：

{
	"success":true
}

获取指定 AI 知识库远端存储的文件列表

请求 URL： /api/knowledge_bases/:id/memories
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：无
返回值：

[
	{
		"id": "cc957dda-7d4f-4cdc-b9c2-56b249fe8f4e",
		"collection_id": "7f1eb18a-705d-4d6d-a165-940523fb496d",
		"integration_id": "ollama",
		"external_user_id": null,
		"external_username": null,
		"key": "211",
		"attrs": null,
		"status": "enabled",
		"embedding_status": "completed",
		"metadata": {},
		"content_type": "text",
		"content": "# 标题一11",
		"created_at": "2025-12-09T07:59:01.264Z",
		"updated_at": null
	}
	...
]

返回值参数说明：

参数	说明
id	ID
collection_id	知识库合集ID
integration_id	集成标识ID
external_user_id	外部用户ID
external_username	外部用户名
key	键
attrs	扩展属性字段
status	数据启用状态
embedding_status	向量化处理状态
metadata	元数据信息
content_type	类型
content	文本内容
created_at	创建时间
updated_at	更新时间

新建 AI 知识库

请求 URL： /api/knowledge_bases
请求方式：POST
Body 信息：

参数	说明
name	名称
data	数据配置

{
	"name":"text1",
	"data":{
		"provider":5
	}
}

响应信息：

{
	"message":	"success",
	"code":	200,
	"data":	50
}

自动生成多个相似的问题

请求 URL： /api/knowledge_bases/gen_questions
请求方式：POST
请求参数：

参数名	类型	是否必填	描述
question	string	是	问题
answer	string	是	答案
additional_questions	array	是	相似问题
provider	int	是	知识库提供者

Body 信息：

参数	说明
question	主问题
additional_questions	拓展问题列表
answer	问题回答内容
provider	大模型编号

{
	"question":"Can you help us set up a remote work system for employees?",
	"additional_questions":[],
	"answer":"Yes. We can help deploy remote work tools (e.g., VPN configuration, cloud collaboration platforms like Microsoft Teams/Google Workspace), set up access permissions for employees, and test the system to ensure stable remote connection and data security.",
	"provider":6
}

返回值：

{
    "model": "qwen3:0.6b",
    "created_at": "2025-12-09T08:30:27.015440592Z",
    "response": "- Can you assist with setting up a remote work environment for employees?  \n- How can we configure a remote work system for our team?  ......",
    "done": true,
    "done_reason": "stop",
    "context": [
        151644,
        872,
        ......
    ],
    "total_duration": 4946612076,
    "load_duration": 988446104,
    "prompt_eval_count": 128,
    "prompt_eval_duration": 470541590,
    "eval_count": 128,
    "eval_duration": 3419634857
}

返回值参数说明：

参数	说明
model	大模型
created_at	生成时间
response	模型返回内容
done	是否生成完成
done_reason	生成结束原因
context	呼叫源
total_duration	总耗时(纳秒)
load_duration	模型加载耗时(纳秒)
prompt_eval_count	提示词评估token数
prompt_eval_duration	提示词评估耗时(纳秒)
eval_count	生成评估token数量
eval_duration	生成评估耗时(纳秒)

为本地知识库上传文件

请求 URL： /api/knowledge_bases/:id/:media_id
请求方式：POST
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID
media_file_id	int	是	文件 ID

Body 信息：无
响应信息：

{
	"code":	200,
	"data":	1,
	"message":	"success"
}

获取指定知识库的全部文件

请求 URL： /api/knowledge_bases/:id/media_files
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：无
返回值：

[
	{
		"domain":	"",
		"file_name":	"",
		"mime":	"application/octet-stream",
		"ext":	"md",
		"geo_position":	"",
		"file_size":	1157,
		"deleted_at":	"",
		"channel_uuid":	"",
		"meta":	"",
		"name":	"text.md",
		"original_file_name":	"text.md",
		"processing_flag":	0,
		"created_at":	"2025-12-09 06:35:32",
		"dir_path":	"/usr/local/freeswitch/storage/upload",
		"id":	206,
		"description":	"UPLOAD",
		"updated_at":	"2025-12-09 06:35:32",
		"type":	"UPLOAD",
		"abs_path":	"/usr/local/freeswitch/storage/upload/upload-20251209143532-019b01d2-836e-7a54-a241-7e302a2601a9.md",
		"thumb_path":	"",
		"rel_path":	"upload-20251209143532-019b01d2-836e-7a54-a241-7e302a2601a9.md"
	}, {
		"domain":	"",
		"file_name":	"",
		"mime":	"application/octet-stream",
		"ext":	"md",
		"geo_position":	"",
		"file_size":	1157,
		"deleted_at":	"",
		"channel_uuid":	"",
		"meta":	"",
		"name":	"text.md",
		"original_file_name":	"text.md",
		"processing_flag":	0,
		"created_at":	"2025-12-09 06:35:35",
		"dir_path":	"/usr/local/freeswitch/storage/upload",
		"id":	207,
		"description":	"UPLOAD",
		"updated_at":	"2025-12-09 06:35:35",
		"type":	"UPLOAD",
		"abs_path":	"/usr/local/freeswitch/storage/upload/upload-20251209143534-019b01d2-8cf3-7dba-94d9-246c80f87279.md",
		"thumb_path":	"",
		"rel_path":	"upload-20251209143534-019b01d2-8cf3-7dba-94d9-246c80f87279.md"
	}
]

返回值参数说明：

参数	说明
domain	域
file_name	存储文件名
mime	文件MIME类型
ext	文件后缀格式
geo_position	地理位置信息
file_size	文件大小（字节）
deleted_at	删除时间
channel_uuid	渠道唯一标识
meta	文件元数据
name	文件展示名称
original_file_name	原始上传文件名
processing_flag	文件处理标记
created_at	创建时间
dir_path	存放目录路径
id	ID
description	描述信息
updated_at	记录更新时间
type	类型
abs_path	绝对路径
thumb_path	缩略图路径
rel_path	相对路径

修改指定知识库

请求 URL： /api/knowledge_bases/:id
请求方式：PUT
Body 信息：

参数	说明
name	名称
description	描述
provider	大模型编号

{
    "name": "test",
    "description": "test",
    "provider": 6
}

响应信息：

{
	"message": "success",
	"code": 200,
	"data": "16"
}

同步多个文件到知识库

请求 URL： /api/knowledge_bases/:id/syncs
请求方式：PUT
Body 信息：文件的在media_files表中的id，多个id用逗号分隔

[241,242]

响应信息：

{
	"message": "success",
	"code": 200,
	"data": [241,242]
}

同步单个文件到知识库

请求 URL： /api/knowledge_bases/:id/mfiles/:media_id/sync
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
media_id	int	是	文件 ID
id	int	是	知识库 ID

Body 信息：无
响应信息：

{
	"code": 200,
	"message": "success",
	"data": "243"
}

同步全部文件到知识库

请求 URL： /api/knowledge_bases/:id/all
请求方式：PUT
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：无
响应信息：

{
	"code": 200,
	"message": "success",
	"data": "16"
}

删除指定文件

请求 URL： /api/knowledge_bases/:id/media_files/:media_id
请求方式：DELETE
请求参数：

参数名	类型	是否必填	描述
media_id	int	是	文件 ID
id	int	是	知识库 ID

Body 信息：无
响应信息：

{
	"code": 200,
	"message": "success",
	"data": "243"
}

删除指定 AI 知识库

请求 URL： /api/knowledge_bases/:id
请求方式：DELETE
请求参数：

参数名	类型	是否必填	描述
id	int	是	知识库 ID

Body 信息：del_mfile 是否同步删除文件，默认不删除

参数	说明
del_mfile	删除文件动作

{
    "del_mfile": true
}

响应信息：

{
	"code": 200,
	"message": "success",
	"data": "16"
}

AI 对话

查询 AI 对话

请求 URL： /api/cherrygpt_logs
请求 URL： /api/cherrygpt_logs?page=1&perPage=500&last=60 查看近60天的对话
请求 URL： /api/cherrygpt_logs?page=1&perPage=500&startDate=2025-07-06&endDate=2025-09-04&cidNumber=823&destNumber=1000479 按条件查询
请求方式：GET
请求参数：

参数名	类型	是否必填	描述
page	int	否	页码
perPage	int	否	每页条数
last	int	否	最近天数
cidNumber	int	否	主叫号码
destNumber	int	否	被叫号码
startDate	string	否	开始时间
endDate	string	否	结束时间

响应信息：

{
	"pageCount":	1,
	"rowCount":	1,
	"page":	1,
	"data":	[{
			"robot_info":	"{\"service_model\":\"ChatGPT\",\"gpt_token\":\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\",\"gpt_model\":\"gpt-4o\",\"gpt_max_tokens\":100,\"gpt_url\":\"https://openai.xswitch.cn/v1/\",\"ASync\":false,\"breakMode\":true}",
			"ai_robot_uuid":	"0ec755d3-5b6c-41e9-91dc-f71ed756c616",
			"channel_uuid":	"019890b3-2816-7b5f-8697-c1b993884121",
			"start_stamp":	"2025-08-10 05:18:37",
			"end_stamp":	"",
			"id":	"109",
			"created_at":	"2025-08-10 05:18:37",
			"cid_number":	"607",
			"domain":	"xyt.xswitch.cn",
			"node_uuid":	"0dbd5892-a0b3-4a3a-b19c-9d9e15d503bd",
			"dest_number":	"10000475"
		}]
}

查询指定 AI 对话

请求 URL： /api/cherrygpt_logs/:id
请求方式：GET
请求参数：
参数名类型是否必填描述
id int 是对话 ID
响应信息：

参数名	类型	是否必填	描述
id	int	是	对话 ID

{
	"data":	{
		"cid_number":	"823",
		"end_stamp":	"",
		"ai_robot_uuid":	"c56038e1-bcac-4c70-82c8-4f6e9b7e6f35",
		"node_uuid":	"567559e7-eb40-4d5e-ab19-1a7654debe69",
		"id":	86,
		"dest_number":	"10000479",
		"created_at":	"2025-07-14 22:47:23",
		"start_stamp":	"2025-07-14 22:47:23",
		"prompts":	[{
				"channel_uuid":	"5976900e-0a1a-9be1-f1a5-2033b66a3602",
				"role":	"assistant",
				"absolute_path":	"/usr/local/freeswitch/storage/recordings/20250714-823-10000479-.wav",
				"mime":	"audio/wav",
				"created_at":	"2025-07-14 22:47:23",
				"id":	384,
				"message_uuid":	"",
				"content":	"喂，你好。",
				"extension":	"wav"
			}, {
				"channel_uuid":	"5976900e-0a1a-9be1-f1a5-2033b66a3602",
				"role":	"user",
				"absolute_path":	"/usr/local/freeswitch/storage/recordings/20250714-823-10000479-333db217422e46e9b3b3599a0da2e679.wav",
				"mime":	"audio/wav",
				"created_at":	"2025-07-14 22:47:29",
				"id":	385,
				"message_uuid":	"333db217-422e-46e9-b3b3-599a0da2e679",
				"content":	"你好",
				"extension":	"wav"
			}...],
		"robot_info":	"{\"service_model\":\"ChatGPT\",\"gpt_token\":\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\",\"gpt_model\":\"gpt-4o\",\"gpt_max_tokens\":100,\"gpt_url\":\"https://openai.xswitch.cn/v1/\",\"ASync\":false,\"breakMode\":true}",
		"domain":	"xyt.xswitch.cn",
		"channel_uuid":	"5976900e-0a1a-9be1-f1a5-2033b66a3602"
	},
	"code":	200,
	"message":	"success"
}

百度模块

查看所有百度实例的信息

请求 URL： /api/baidus
请求方式： GET
Body 信息：无
返回值：

[
  {
    "name": "baidu",
    "deleted_at": "",
    "disabled": 1,
    "description": "",
    "updated_at": "2022-05-17 12:20:56",
    "created_at": "2022-05-17 12:20:56",
    "id": 1
  }
]

curl 示例：

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/baidus

查看指定百度实例的详细信息

请求 URL： /api/baidus/:id
请求方式： GET
Body 信息：无
返回值：

{
	"disabled":	0,
	"params":	[{
			"disabled":	"0",
			"realm":	"BAIDU-TTS",
			"deleted_at":	"",
			"ref_id":	"1",
			"k":	"token-url",
			"updated_at":	"2025-09-03 01:42:53",
			"created_at":	"2025-09-03 01:42:53",
			"id":	"883",
			"v":	"https://openapi.baidu.com/oauth/2.0/token"
		}, {
			"disabled":	"0",
			"realm":	"BAIDU-TTS",
			"deleted_at":	"",
			"ref_id":	"1",
			"k":	"tts-url",
			"updated_at":	"2025-09-03 01:42:53",
			"created_at":	"2025-09-03 01:42:53",
			"id":	"884",
			"v":	"http://tsn.baidu.com//text2audio"
		}
    ...
    ],
	"name":	"baidu",
	"updated_at":	"2025-09-03 01:42:52",
	"description":	"default",
	"created_at":	"2025-09-03 01:42:52",
	"id":	1,
	"deleted_at":	""
}

创建百度实例

请求 URL： /api/baidus
请求方式： POST
Body 信息：

参数	说明
name	baidu profile 名称
description	baidu profile 描述
template	模板，默认模板："default"

{
  "name": "test",
  "description": "test",
  "template": "default"
}

返回值：

{
  "code": 200,
  "data": 2,
  "message": "success"
}

curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"name": "test","description": "test","template": "default"}' 192.168.1.100:8081/api/baidus

修改指定百度实例的名称和描述

请求 URL： /api/baidus/$id
请求方式： PUT
Body 信息：

参数	说明
name	baidu profile 名称
description	baidu profile 描述
id	profile ID

{
  "name": "baidu",
  "description": "百度模块",
  "id": "1"
}

返回值：

{
  "data": "1",
  "message": "success",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"name": "baidu","description": "百度模块","id": "1"}' 192.168.1.100:8081/api/baidus/1

创建指定百度实例中 TTS 和 ASR 参数

请求 URL： /api/baidus/$id/params
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

// TTS参数
{
	"k": "text1",
	"realm": "BAIDU-TTS",
	"v": "t1"
}

//ASR参数
{
	"k": "text2",
	"realm": "BAIDU-ASR",
	"v": "t2"
}

返回值：

{
  "code": 200,
  "message": "success",
  "data": 1574
}

curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"k": "text1","v": "t1","realm": "BAIDU-TTS"}' 192.168.1.100:8081/api/baidus/1/params

修改指定百度实例中 TTS 或 ASR 参数

请求 URL： /api/baidus/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k": "token-url",
  "realm": "BAIDU-TTS",
  "v": "https://openapi.baidu.com/oauth/2.0/token"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"k": "token-url","v": "https://openapi.baidu.com/oauth/2.0/token","realm": "BAIDU-TTS"}' 192.168.1.100:8081/api/baidus/1/params/1574

启用/禁用指定百度实例中 TTS 或 ASR 参数

请求 URL： /api/baidus/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
action	变更启用状态，固定为"toggle"

{
  "action": "toggle"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"action": "toggle"}' 192.168.1.100:8081/api/baidus/1/params/1574

删除指定百度实例中 TTS 或 ASR 参数

请求 URL： /api/baidus/$id/params/$params_id
请求方式： DELETE
Body 信息：无
返回值：

{
  "code": 200,
  "message": "success",
  "data": "1"
}

curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE 192.168.1.100:8081/api/baidus/1/params/1

删除指定百度实例

请求 URL： /api/baidus/$id
请求方式： DELETE
Body 信息：无
返回值：

{
  "message": "success",
  "data": "2",
  "code": 200
}

curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE 192.168.1.100:8081/api/baidus/2

"阿里"、"华为"、"讯飞"、"腾讯"、"思必驰"、"微软 Azure"、"阶跃"模块

在 AI 接口中，对于"阿里"，"华为"，"讯飞"，"腾讯"，"思必驰"，"微软 Azure"，"阶跃"模块，调用接口参数一致，URL 进行调整：

阿里：https://192.168.3.222/api/ali_profiles
华为：https://192.168.3.222/api/huawei_profiles
讯飞：https://192.168.3.222/api/xunfei_profiles
腾讯：https://192.168.3.222/api/tencent_profiles
思必驰：https://192.168.3.222/api/aispeech_profiles
微软 Azure：https://192.168.3.222/api/azure_profiles
阶跃：https://192.168.3.222/api/stepfun_profiles

各模块对应的 realm	说明
阿里	ALI-SETTINGS ALI-TTS ALI-ASR ALI-BL-TTS ALI-BL-ASR ALI-QWEN-TTS ALI-QWEN-ASR ALI-QWEN-TTS-WS ALI-QWEN-TTS-CLONE
华为	HUAWEI-SETTINGS HUAWEI-TTS HUAWEI-ASR
讯飞	XUNFEI-SETTINGS XUNFEI-TTS XUNFEI-ASR XUNFEI-MVAD XUNFEI-ASR-SHORT XUNFEI-ASR-SPARK XUNFEI-ASR-SPARK2 XUNFEI-ASR-NATIVE
腾讯	TENCENT-ASR-WS TENCENT-ASR-REST TENCENT-TTS-WS TENCENT-TTS-REST
思必驰	AISPEECH-SETTINGS AISPEECH-TTS AISPEECH-ASR
微软 Azure	AZURE-TTS AZURE-TTS-WS AZURE-TTS-WS2 AZURE-ASR AZURE-ASR-WS
阶跃	STEPFUN-TTS-REST STEPFUN-TTS-WS STEPFUN-ASR

以阿里模块为例：

查看阿里实例列表

请求 URL： /api/ali_profiles
请求方式： GET
Body 信息：无
返回值：

[
  {
		"updated_at":	"2025-09-03 01:42:52",
		"deleted_at":	"",
		"created_at":	"2025-09-03 01:42:52",
		"id":	1,
		"description":	"default",
		"disabled":	0,
		"name":	"ali"
	}
]

curl 示例：

curl -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/ali_profiles

查看指定阿里实例的详细信息

请求 URL： /api/ali_profiles/:id
请求方式： GET
Body 信息：无
返回值：

{
	"created_at":	"2025-09-03 01:42:52",
	"params":	[{
			"deleted_at":	"",
			"id":	"713",
			"disabled":	"0",
			"created_at":	"2025-09-03 01:42:53",
			"ref_id":	"1",
			"v":	"http://nls-meta.cn-shanghai.aliyuncs.com/",
			"updated_at":	"2025-09-03 01:42:53",
			"k":	"token-url",
			"realm":	"ALI-SETTINGS"
		}, {
			"deleted_at":	"",
			"id":	"714",
			"disabled":	"0",
			"created_at":	"2025-09-03 01:42:53",
			"ref_id":	"1",
			"v":	"cn-shanghai",
			"updated_at":	"2025-09-03 01:42:53",
			"k":	"region",
			"realm":	"ALI-SETTINGS"
		}
    ...
    ],
	"deleted_at":	"",
	"updated_at":	"2025-09-03 01:42:52",
	"description":	"default",
	"id":	1,
	"name":	"ali",
	"disabled":	0
}

创建阿里实例

请求 URL： /api/ali_profiles
请求方式： POST
Body 信息：

参数	说明
name	ali profile 名称
description	ali profile 描述
template	模板，默认模板："default"

{
  "name": "test",
  "description": "test",
  "template": "default"
}

返回值：

{
  "code": 200,
  "data": 2,
  "message": "success"
}

curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"name": "test","description": "test","template": "default"}' 192.168.1.100:8081/api/ali_profiles

修改阿里实例名称和描述

请求 URL： /api/ali_profiles/$id
请求方式： PUT
Body 信息：

参数	说明
name	ali profile 名称
description	ali profile 描述
id	profile ID

{
  "name": "ali",
  "description": "阿里实例",
  "id": "1"
}

返回值：

{
  "data": "1",
  "message": "success",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"name": "ali","description": "阿里实例","id": "1"}' 192.168.1.100:8081/api/ali_profiles/1

启用/禁用阿里实例

请求 URL： /api/ali_profiles/toggle/:id
请求方式： PUT
Body 信息：

{
  "action": "aliyun"
}

返回值：

{
	"data":	[{
			"id":	1,
			"description":	"default",
			"name":	"ali",
			"disabled":	1,
			"deleted_at":	"",
			"updated_at":	"2025-09-03 02:53:43",
			"created_at":	"2025-09-03 01:42:52"
		}, {
			"id":	2,
			"description":	"",
			"name":	"text11",
			"disabled":	0,
			"deleted_at":	"",
			"updated_at":	"2025-09-03 02:53:43",
			"created_at":	"2025-09-03 02:34:22"
		}],
	"message":	"success",
	"code":	200
}

创建阿里实例中参数

请求 URL： /api/ali_profiles/$id/params
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

// Settings参数
{
	"k": "text1",
	"realm": "ALI-SETTINGS",
	"v": "t1"
}

// TTS参数
{
	"k": "text1",
	"realm": "ALI-TTS",
	"v": "t1"
}

//ASR参数
{
	"k": "text2",
	"realm": "ALI-ASR",
	"v": "t2"
}

//BaiLian TTS参数
{
	"k": "text3",
	"realm": "ALI-BL-TTS",
	"v": "t1"
}

//BaiLian ASR参数
{
	"k": "text4",
	"realm": "ALI-BL-ASR",
	"v": "t2"
}

返回值：

{
  "code": 200,
  "message": "success",
  "data": 1574
}

curl 示例：

curl -XPOST -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"k": "text1","v": "t1","realm": "ali-TTS"}' 192.168.1.100:8081/api/ali_profiles/1/params

修改阿里实例中参数

请求 URL： /api/ali_profiles/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k": "token-url",
  "realm": "ALI-TTS",
  "v": "https://nls-gateway.cn-shanghai.aliyuncs.com/stream/v1/tts"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"k": "token-url","v": "https://openapi.ali.com/oauth/2.0/token","realm": "ali-TTS"}' 192.168.1.100:8081/api/ali_profiles/1/params/1574

启用/禁用阿里实例中参数

请求 URL： /api/ali_profiles/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
action	变更启用状态，固定为"toggle"

{
  "action": "toggle"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

curl 示例：

curl -XPUT -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -d '{"action": "toggle"}' 192.168.1.100:8081/api/ali_profiles/1/params/1574

删除阿里实例中参数

请求 URL： /api/ali_profiles/$id/params/$params_id
请求方式： DELETE
Body 信息：无
返回值：

{
  "code": 200,
  "message": "success",
  "data": "1"
}

curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE 192.168.1.100:8081/api/ali_profiles/1/params/1

删除阿里实例

请求 URL： /api/ali_profiles/$id
请求方式： DELETE
Body 信息：无
返回值：

{
  "message": "success",
  "data": "2",
  "code": 200
}

curl 示例：

curl -0 -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" -XDELETE 192.168.1.100:8081/api/ali_profiles/2

MiniMax

查看 MiniMax 的配置

请求 URL： /api/minimax_profiles
请求方式： GET
Body 信息：无
返回值：

[
  {
		"id":	1,
		"disabled":	0,
		"deleted_at":	"",
		"description":	"default",
		"created_at":	"2025-09-03 01:42:52",
		"updated_at":	"2025-09-03 01:42:52",
		"name":	"default"
	}
]

查看指定 MiniMax 实例的详细信息

请求 URL： /api/minimax_profiles/:id
请求方式： GET
Body 信息：无
返回值：

{
	"params":	[{
			"id":	"2619",
			"created_at":	"2025-09-03 01:42:54",
			"v":	"https://api.minimax.chat/v1/tts/stream",
			"disabled":	"0",
			"ref_id":	"1",
			"deleted_at":	"",
			"k":	"tts-url",
			"realm":	"MINIMAX-TTS",
			"updated_at":	"2025-09-03 01:42:54"
		}, {
			"id":	"2620",
			"created_at":	"2025-09-03 01:42:54",
			"v":	"",
			"disabled":	"0",
			"ref_id":	"1",
			"deleted_at":	"",
			"k":	"token",
			"realm":	"MINIMAX-TTS",
			"updated_at":	"2025-09-03 01:42:54"
		}
    ...
    ],
	"disabled":	0,
	"description":	"default",
	"updated_at":	"2025-09-03 01:42:52",
	"name":	"default",
	"deleted_at":	"",
	"id":	1,
	"created_at":	"2025-09-03 01:42:52"
}

创建 MiniMax 实例

请求 URL： /api/minimax_profiles
请求方式： POST
Body 信息：

参数	说明
name	MiniMax profile 名称
description	MiniMax profile 描述
template	模板，默认模板："default"

{
  "name": "test",
  "description": "test",
  "template": "default",
  "disabled": "1"
}

返回值：

{
  "code": 200,
  "data": 2,
  "message": "success"
}

修改指定 MiniMax 实例的名称和描述

请求 URL： /api/minimax_profiles/$id
请求方式： PUT
Body 信息：

参数	说明
name	MiniMax profile 名称
description	MiniMax profile 描述
id	profile ID

{
  "name": "MiniMax",
  "description": "MiniMax实例",
  "id": "1"
}

返回值：

{
  "data": "1",
  "message": "success",
  "code": 200
}

启用/禁用指定 MiniMax 实例

请求 URL： /api/minimax_profiles/toggle/:id
请求方式： PUT
Body 信息：

{
  "disabled": 0
}

返回值：

{
	"message":	"success",
	"code":	200,
	"data":	"4"
}

创建指定 MiniMax 实例中的 TTS 参数

请求 URL： /api/minimax_profiles/:id/tts/
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k":"text",
  "v":"text",
  "realm":"MINIMAX-TTS"
}

返回值：

{
	"data":	3313,
	"message":	"success",
	"code":	200
}

创建指定 MiniMax 实例中的 TTSV2 参数

请求 URL： /api/minimax_profiles/:id/ttsv2/
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k":"text",
  "v":"text",
  "realm":"MINIMAX-TTSV2"
}

返回值：

{
	"data":	3314,
	"message":	"success",
	"code":	200
}

创建指定 MiniMax 实例中的 TTSV2 WS 参数

请求 URL： /api/minimax_profiles/:id/ttsv2ws/
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k":"text",
  "v":"text",
  "realm":"MINIMAX-TTSV2-WS"
}

返回值：

{
	"message":	"success",
	"data":	3316,
	"code":	200
}

修改指定 MiniMax 实例中的指定参数

请求 URL： /api/minimax_profiles/$id/tts/$param_id
请求方式： PUT
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k": "token-url",
  "realm": "MiniMax-TTS",
  "v": "https://api.minimax.chat/v1/tts/stream"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

启用/禁用指定 MiniMax 实例中的指定参数

请求 URL： /api/minimax_profiles/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
action	变更启用状态，固定为"toggle"

{
  "action": "toggle"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

删除指定 MiniMax 实例中的指定参数

请求 URL： /api/minimax_profiles/:id/tts/:params_id
请求方式： DELETE
Body 信息：无
返回值：

{
  "code": 200,
  "message": "success",
  "data": "1"
}

删除 MiniMax 实例

请求 URL： /api/minimax_profiles/:id
请求方式： DELETE
Body 信息：无
返回值：

{
  "message": "success",
  "data": "2",
  "code": 200
}

火山引擎

查看火山引擎的实例列表

请求 URL： /api/volcengine_profiles
请求方式： GET
Body 信息：无
返回值：

[
  {
		"name":	"default",
		"created_at":	"2025-09-03 01:42:52",
		"description":	"default",
		"updated_at":	"2025-09-03 01:42:52",
		"id":	1,
		"deleted_at":	"",
		"disabled":	0
	}
]

查看指定火山引擎实例的详细信息

请求 URL： /api/volcengine_profiles/:id
请求方式： GET
Body 信息：无
返回值：

{
	"disabled":	0,
	"created_at":	"2025-09-03 01:42:52",
	"name":	"default",
	"description":	"default",
	"params":	[{
			"disabled":	"0",
			"created_at":	"2025-09-03 01:42:54",
			"realm":	"VOLCENGINE-TTS",
			"ref_id":	"1",
			"updated_at":	"2025-09-03 01:42:54",
			"deleted_at":	"",
			"v":	"wss://openspeech.bytedance.com/api/v1/tts/ws_binary",
			"k":	"tts-url",
			"id":	"2755"
		}, {
			"disabled":	"0",
			"created_at":	"2025-09-03 01:42:54",
			"realm":	"VOLCENGINE-TTS",
			"ref_id":	"1",
			"updated_at":	"2025-09-03 01:42:54",
			"deleted_at":	"",
			"v":	"volcano_tts",
			"k":	"cluster",
			"id":	"2756"
		}
    ...
    ],
	"updated_at":	"2025-09-03 01:42:52",
	"deleted_at":	"",
	"id":	1
}

创建火山引擎实例

请求 URL： /api/volcengine_profiles
请求方式： POST
Body 信息：

参数	说明
name	火山引擎 profile 名称
description	火山引擎 profile 描述
template	模板，默认模板："default"

{
  "name":"text1",
  "description":"text1",
  "template":"default",
  "disabled":"1"
}

返回值：

{
  "code": 200,
  "data": 2,
  "message": "success"
}

修改指定火山引擎实例的名称和描述

请求 URL： /api/volcengine_profiles/$id
请求方式： PUT
Body 信息：

参数	说明
name	火山引擎 profile 名称
description	火山引擎 profile 描述
id	profile ID

{
  "name": "text",
  "description": "火山引擎实例",
  "id": "1"
}

返回值：

{
  "data": "1",
  "message": "success",
  "code": 200
}

启用/禁用火山引擎实例

请求 URL： /api/volcengine_profiles/toggle/:id
请求方式： PUT
Body 信息：

{
  "disabled": 0
}

返回值：

{
	"message":	"success",
	"code":	200,
	"data":	"1"
}

创建指定火山引擎实例中的 TTS 参数

请求 URL： /api/volcengine_profiles/:id/tts/
请求方式： POST
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k":"text",
  "v":"text",
  "realm":"VOLCENGINE-TTS"
}

返回值：

{
	"data":	3334,
	"message":	"success",
	"code":	200
}

修改指定火山引擎实例中的指定参数

请求 URL： /api/volcengine_profiles/$id/tts/$param_id
请求方式： PUT
Body 信息：

参数	说明
k	参数名称
v	参数数值
realm	参数域

{
  "k": "tts-url",
  "realm": "VOLCENGINE-TTS",
  "v": "wss://openspeech.bytedance.com/api/v1/tts/ws_binary"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

启用/禁用指定火山引擎实例中的指定参数

请求 URL： /api/volcengine_profiles/$id/params/$param_id
请求方式： PUT
Body 信息：

参数	说明
action	变更启用状态，固定为"toggle"

{
  "action": "toggle"
}

返回值：

{
  "message": "success",
  "data": "1574",
  "code": 200
}

删除指定火山引擎实例中的参数

请求 URL： /api/volcengine_profiles/:id/tts/:params_id
请求方式： DELETE
Body 信息：无
返回值：

{
  "code": 200,
  "message": "success",
  "data": "1"
}

删除指定火山引擎实例

请求 URL： /api/volcengine_profiles/:id
请求方式： DELETE
Body 信息：无
返回值：

{
  "message": "success",
  "data": "2",
  "code": 200
}

"NCNN" 和 "ONNX"

NCNN ONNX 模型配置的api,仅有开头不同，故此不再赘述 NCNN /api/ncnn_profiles/ ONNX /api/onnx_profiles/ 这里以 NCNN 为例：

查询 NCNN 模型

请求 URL： /api/ncnn_profiles
请求方式：GET
响应信息：

[
	{
		"description":	"default",
		"name":	"default",
		"id":	1,
		"disabled":	0,
		"deleted_at":	"",
		"created_at":	"2026-03-27 02:01:37",
		"updated_at":	"2026-03-27 02:01:37",
	}
]

查询指定 NCNN 模型

请求 URL： /api/ncnn_profiles/:id
请求方式：GET
请求参数：
参数名类型是否必填描述
id int 是模型 ID
响应信息：

{
	"description":	"default",
	"params":	[{
			"realm":	"NCNN-SETTINGS",
			"created_at":	"2026-03-27 02:02:00",
			"k":	"model-dir",
			"id":	"3733",
			"ref_id":	"1",
			"disabled":	"1",
			"v":	"$${storage_dir}/ncnn",
			"deleted_at":	"",
			"updated_at":	"2026-03-27 02:02:00"
		}...],
	"deleted_at":	"",
	"disabled":	0,
	"name":	"default",
	"id":	1,
	"created_at":	"2026-03-27 02:01:37",
	"updated_at":	"2026-03-27 02:01:37"
}

创建 NCNN 模型

请求 URL： /api/ncnn_profiles
请求方式：POST
请求参数：
参数名类型是否必填描述
name string 是模型名称
description string 否模型描述
template string 是模版
Body:

{
	"name":"test",
	"description":"test",
	"template":"default"
}

响应信息：

{
	"data":	2,
	"code":	200,
	"message":	"success"
}

修改 NCNN 模型

请求 URL： /api/ncnn_profiles/:id
请求方式：PUT
请求参数：
参数名类型是否必填描述
id int 是模型 ID
name string 是模型名称
description string 否模型描述
template string 是模版
Body:

{
	"name":"test",
	"description":"test11",
	"id":2
}

响应信息：

{
	"code":	200,
	"data":	"2",
	"message":	"success"
}

启用/禁用指定模型

请求 URL： /api/ncnn_profiles/toggle/:id
请求方式：PUT
响应信息：

{
	"code":	200,
	"message":	"success",
	"data":	[{
			"disabled":	1,
			"updated_at":	"2026-03-27 02:01:37",
			"deleted_at":	"",
			"description":	"default",
			"created_at":	"2026-03-27 02:01:37",
			"name":	"default",
			"id":	1
		}, {
			"disabled":	0,
			"updated_at":	"2026-03-31 07:59:47",
			"deleted_at":	"",
			"description":	"test11",
			"created_at":	"2026-03-31 07:59:47",
			"name":	"text",
			"id":	2
		}]
}

创建指定模型的参数

请求 URL： /api/ncnn_profiles/:id/params
请求方式：POST
请求参数：
参数名类型是否必填描述
realm string 是参数域
k string 是参数键
v string 是参数值
Body:

{
	"k":"test",
	"v":"test",
	"realm":"NCNN-SETTINGS"
}

响应信息：

{
	"data":	3974,
	"message":	"success",
	"code":	200
}

修改指定模型的指定参数

请求 URL： /api/ncnn_profiles/:id/params/:param_id
请求方式：PUT
请求参数：
参数名类型是否必填描述
realm string 是参数域
k string 是参数键
v string 是参数值
Body:

{
	"k":"test",
	"v":"test11",
	"realm":"NCNN-SETTINGS"
}

响应信息：

{
	"code":	200,
	"data":	"3974",
	"message":	"success"
}

删除指定模型的指定参数

请求 URL： /api/ncnn_profiles/:id/params/:param_id
请求方式：DELETE
响应信息：

{
	"message":	"success",
	"code":	200,
	"data":	"3974"
}

删除指定模型

请求 URL： /api/ncnn_profiles/:id
请求方式：DELETE
响应信息：

{
	"message":	"success",
	"code":	200,
	"data":	"2"
}

参数名	类型	是否必填	描述
name	string	是	模型名称
description	string	否	模型描述
template	string	是	模版

参数名	类型	是否必填	描述
id	int	是	模型 ID
name	string	是	模型名称
description	string	否	模型描述
template	string	是	模版