RegisterAgent
https://aigc-aiagent-api.zegotech.cn/
通过向本接口传入基础配置，您可以注册一个智能体（Agent），以用于创建智能体实例。
Request
Query Parameters
Possible values: [RegisterAgent]
接口原型参数
https://aigc-aiagent-api.zegotech.cn?Action=RegisterAgent
AppId，ZEGO 分配的用户唯一凭证。
随机字符串。
Unix 时间戳，单位为秒。最多允许 10 分钟的误差。
签名，用于验证请求的合法性。
Possible values: [2.0]
签名版本号，默认值为 2.0。
- application/json
Body
required
- MiniMax：https://api.minimax.chat/v1/text/chatcompletion_v2
- 火山引擎（豆包）：https://ark.cn-beijing.volces.com/api/v3/chat/completions
- 阿里云百炼（通义千问）：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions
- 阶跃星辰：https://api.stepfun.com/v1/chat/completions
- MiniMax：
- MiniMax-Text-01
- 火山引擎（豆包）：
- doubao-1-5-pro-32k-250115
- doubao-1-5-lite-32k-250115
- 阿里云百炼（通义千问）：
- qwen-plus
- 阶跃星辰：
- step-2-16k
- room_id: 房间 ID
- user_id: 用户 ID
- agent_instance_id: 智能体实例 ID
- Aliyun: 阿里云
- ByteDance: 字节跳动火山语音（大模型语音合成 API）
- ByteDanceFlowing: 字节跳动火山语音（流式语音合成 API (WebSocket)）
- MiniMax: MiniMax
- CosyVoice: 阿里云 CosyVoice
- Aliyun
- ByteDance
- ByteDanceFlowing
- MiniMax
- CosyVoice
- Aliyun:
- ByteDance:
- ByteDanceFlowing:
- Minimax:
- CosyVoice:
- Array[
- ]
- 16k_zh：中文通用；
- 16k_zh-PY：中英粤；
- 16k_zh-TW：中文繁体；
- 16k_zh_edu：中文教育；
- 16k_zh_medical：中文医疗；
- 16k_zh_court：中文法庭；
- 16k_yue：粤语；
- 16k_en：英文通用；
- 16k_en_game：英文游戏；
- 16k_en_edu：英文教育；
- 16k_ko：韩语；
- 16k_ja：日语；
- 16k_th：泰语；
- 16k_id：印度尼西亚语；
- 16k_vi：越南语；
- 16k_ms：马来语；
- 16k_fil：菲律宾语；
- 16k_pt：葡萄牙语；
- 16k_tr：土耳其语；
- 16k_ar：阿拉伯语；
- 16k_es：西班牙语；
- 16k_hi：印地语；
- 16k_fr：法语；
- 16k_de：德语；
- 16k_zh_dialect：中文普通话 + 多方言混合引擎，除普通话外支持23种方言（上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话）；
Possible values: <= 128 characters
仅支持数字、英文字符、和以下特殊字符：!#$%&()+-:;<=.>?@[]^_{}|~,。
Possible values: <= 256 characters
智能体名称，长度不超过 256 字节。
LLM objectrequired
接收请求的端点（可以是你自己的服务，也可以是任何 LLM 服务提供商提供的服务），并且必须兼容 OpenAI Chat Completions API。
例如：https://api.openai.com/v1/chat/completions
📌 重要说明
如果 ApiKey 设置为 "zego_test"，则必须使用以下 Url 地址之一：
LLM 服务提供商用于认证的参数。默认为空，但在生产环境中必须提供。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
LLM 模型。不同的 LLM 服务提供商支持不同的模型，请参考其官方文档选择合适的模型。
📌 重要说明
如果 ApiKey 设置为 "zego_test"，则必须使用以下模型之一：
智能体系统提示（prompt）。调用 LLM 时附加在最前的预定义信息，用于控制 LLM 输出。可以是角色设定、提示词和回答样例等。
Possible values: >= 0 and <= 2
Default value: 0.7
数值越高，输出越随机；数值越低，输出越集中和确定。
Possible values: >= 0 and <= 1
Default value: 0.9
采样方法，数值越小，确定性越强；数值越大，随机性越强。
LLM 服务提供商支持的其他参数，如最大 Token 数量限制等。不同的 LLM 提供商支持不同的参数，请参考其官方文档并根据需要填写。
Default value: false
如果此值为 true，AI Agent 服务器在请求 LLM 服务时会在请求参数中包含智能体信息。 您可以使用此参数在自定义 LLM 服务中执行额外的业务逻辑。
agent_info 的结构如下：
TTS objectrequired
Possible values: [Aliyun, ByteDance, ByteDanceFlowing, MiniMax, CosyVoice]
语音合成（TTS）服务提供商。选项：
Params objectrequired
TTS 配置参数，格式为 JSON 对象。包含 app 参数（用于认证）和其他参数（用于调整 TTS 效果）。
除 app 参数外，还可以传入其他 TTS 配置参数来调整语音合成效果，这些参数会直接透传给对应的 TTS 服务提供商。
您可以根据 Vendor 的值，参考如下服务提供商的官方文档获取所需信息：
- Aliyun：智能语音合成 - 接口说明
- ByteDance：大模型语音合成 API - 参数列表 - 请求参数
- ByteDanceFlowing：双向流式 API - WebSocket 二进制协议 中的 “Payload 请求参数”
- MiniMax：语音模型 - T2A v2 - WebSocket - 接口请求参数
- CosyVoice：语音合成CosyVoice WebSocket API 中的 “payload 请求参数”
app object required
请参考阿里云文档 智能语音交互 - 快速入门 - 从这里开始 中 “步骤 4：管理项目” 获取 AppKey 并传入此处。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考阿里云文档 智能语音交互 - 快速入门 - 从这里开始 中 “步骤 2：创建 AccessKey” 获取 AccessKey ID 并传入此处。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考阿里云文档 智能语音交互 - 快速入门 - 从这里开始 中 “步骤 2：创建 AccessKey” 获取 AccessKey Secret 并传入此处。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考火山引擎文档 语音技术 - 快速入门 - 控制台使用 FAQ 中 “哪里可以获取到以下参数appid，cluster，token，authorization_type，secret_key ？”。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考火山引擎文档 语音技术 - 快速入门 - 控制台使用 FAQ 中 “哪里可以获取到以下参数appid，cluster，token，authorization_type，secret_key ？”。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
Possible values: [volcano_tts, volcano_mega, volcano_icl]
Default value: volcano_tts
火山引擎集群配置
📌 重要说明
此参数需与 audio.voice_type 参数匹配。
请参考火山引擎文档 语音技术 - 快速入门 - 控制台使用 FAQ 中 “哪里可以获取到以下参数appid，cluster，token，authorization_type，secret_key ？”。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考火山引擎文档 语音技术 - 快速入门 - 控制台使用 FAQ 中 “哪里可以获取到以下参数appid，cluster，token，authorization_type，secret_key ？”。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
Possible values: [volc.service_type.10029, volc.megatts.default, volc.megatts.concurr]
Default value: volc.service_type.10029
火山引擎资源 ID
📌 重要说明
此参数需与 req_params.speaker 参数匹配。
请参考 MiniMax 文档 快速开始 获取 api key 并传入此处。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
请参考 CosyVoice 文档 获取API Key 获取 api key 并传入此处。
📌 重要说明
在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。
📌 重要说明
other_params 不是一个有效参数，仅仅是为了说明如何透传厂商参数。 除 app 参数外，其余参数均直接透传厂商参数。
以下是各家厂商的参数填写示例，请根据实际需求填写：
"TTS": {
"Vendor": "Aliyun",
"Params": {
"app":{
"app_key": "your key",
"ak_id": "your ak id",
"ak_key": "your ak key"
},
"voice": "zhitian_emo"
}
}
"TTS": {
"Vendor": "Aliyun",
"Params": {
"app":{
"app_key": "your key",
"ak_id": "your ak id",
"ak_key": "your ak key"
},
"voice": "zhitian_emo"
}
}
/*
cluster 配置说明：
默认 ：volcano_tts：普通音色的集群
volcano_mega： 声音复刻大模型 1.0
volcano_icl：声音复刻大模型 2.0
*/
"TTS": {
"Vendor": "ByteDance",
"Params": {
"app": {
"appid": "your_appid",
"token": "your_token",
"cluster": "volcano_tts"
},
"audio": {
"voice_type": "your_voice_type"
}
}
}
/*
cluster 配置说明：
默认 ：volcano_tts：普通音色的集群
volcano_mega： 声音复刻大模型 1.0
volcano_icl：声音复刻大模型 2.0
*/
"TTS": {
"Vendor": "ByteDance",
"Params": {
"app": {
"appid": "your_appid",
"token": "your_token",
"cluster": "volcano_tts"
},
"audio": {
"voice_type": "your_voice_type"
}
}
}
/*
resource_id 配置说明：
默认 ：volc.service_type.10029， 即：火山大模型语音合成
声音复刻2.0：
volc.megatts.default（小时版）
volc.megatts.concurr（并发版）
⚠️（不支持声音复刻1.0）
⚠️注意：speaker（音色id）和resource_id 要匹配
*/
"TTS": {
"Vendor": "ByteDanceFlowing",
"Params": {
"app": {
"appid": "your appid",
"token": "your token",
"resource_id": "volc.service_type.10029" // 音色resourceid
},
"req_params": {
"speaker": "zh_female_qingxinnvsheng_mars_bigtts" //音色id
}
}
}
/*
resource_id 配置说明：
默认 ：volc.service_type.10029， 即：火山大模型语音合成
声音复刻2.0：
volc.megatts.default（小时版）
volc.megatts.concurr（并发版）
⚠️（不支持声音复刻1.0）
⚠️注意：speaker（音色id）和resource_id 要匹配
*/
"TTS": {
"Vendor": "ByteDanceFlowing",
"Params": {
"app": {
"appid": "your appid",
"token": "your token",
"resource_id": "volc.service_type.10029" // 音色resourceid
},
"req_params": {
"speaker": "zh_female_qingxinnvsheng_mars_bigtts" //音色id
}
}
}
"TTS": {
"Vendor": "MiniMax",
"Params": {
"app": {
"group_id": "your_group_id",
"api_key": "your_api_key",
},
"model": "speech-02-turbo-preview",
"voice_setting": {
"voice_id": "male-qn-qingse"
}
}
}
"TTS": {
"Vendor": "MiniMax",
"Params": {
"app": {
"group_id": "your_group_id",
"api_key": "your_api_key",
},
"model": "speech-02-turbo-preview",
"voice_setting": {
"voice_id": "male-qn-qingse"
}
}
}
{
"Vendor": "CosyVoice",
"Params": {
"app": {
"api_key": "your_api_key"
},
"payload": {
"model": "cosyvoice-v2",
"parameters": {
"voice": "longxiaochun_v2"
}
}
}
}
{
"Vendor": "CosyVoice",
"Params": {
"app": {
"api_key": "your_api_key"
},
"payload": {
"model": "cosyvoice-v2",
"parameters": {
"voice": "longxiaochun_v2"
}
}
}
}
FilterText object[]
过滤文本的开始标点符号。例如，如果要过滤 () 中的内容，请设置为 (。
过滤文本的结束标点符号。例如，如果要过滤 () 中的内容，请设置为 )。
Possible values: <= 4 characters
可用于设置 TTS 的终止文本。若输入 TTS 的文本中出现匹配 TerminatorText 字符串的内容，则本轮 TTS 从 TerminatorText 字符串（包含）开始的内容将不再进行语音合成。
📌 重要说明
双向流式只能设置一个字符。
ASR object
热词列表用于提高识别准确率。格式：Hotword1|Weight1,Hotword2|Weight2,Hotword3|Weight3
单个热词不超过 30 个字符（最多 10 个汉字），不能包含空格，权重范围：[-1, 11]。 最多支持 128 个热词
📌 重要说明
当权重为 11 时，表示该词为超级热词。建议仅将重要且必须生效的热词设置到 11，过多权重为 11 的热词会影响识别效果。
Params object
Possible values: [16k_zh, 16k_zh-PY, 16k_zh-TW, 16k_zh_edu, 16k_zh_medical, 16k_zh_court, 16k_yue, 16k_en, 16k_en_game, 16k_en_edu, 16k_ko, 16k_ja, 16k_th, 16k_id, 16k_vi, 16k_ms, 16k_fil, 16k_pt, 16k_tr, 16k_ar, 16k_es, 16k_hi, 16k_fr, 16k_de, 16k_zh_dialect]
Default value: 16k_zh
设置识别引擎模型类型
点击展开查看支持的语言类型详细说明
Possible values: >= 200 and <= 2000
Default value: 500
用于设置用户说话停顿多少秒后，不再将两句话视为一句。 单位为 ms，范围 [200，2000]，默认为 500。
Possible values: >= 200 and <= 2000
用于设置用户说话停顿多少秒内，将两句话视为一句，即 ASR 多句拼接。 单位为 ms，范围 [200，2000]。 仅当此值大于 VADSilenceSegmentation 时，才会启用 ASR 多句拼接。
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
Click the "Send" button above and see the response here!