注册智能体

描述

通过向本接口传入基础配置，您可以注册一个智能体（Agent），以用于创建智能体实例。

接口原型

请求方法：POST
请求体格式：JSON
请求地址：https://aigc-aiagent-api.zegotech.cn?Action=RegisterAgent
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
AgentId	String	是	仅支持数字、英文字符、和以下特殊字符：`!#$%&()+-:;\<=.>?@[]^_\{}\|~,`。长度上限为 128 字节。说明请保证 AgentId 在同一 AppID 下唯一。
Name	String	否	智能体名称，长度不超过 256 字节。
LLM	Object	是	大语言模型参数。本参数结构，请见智能体参数说明 - LLM。
TTS	Object	是	文本转语音参数。本参数结构，请见智能体参数说明 - TTS。
ASR	Object	否	语音识别参数。本参数结构，请见智能体参数说明 - ASR。

请求示例

请求地址 URL：

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=RegisterAgent
&<公共请求参数>

Copied!

请求消息体：

Untitled

{
    "AgentId": "xiaozhi",
    "Name": "小智",
    "LLM": {
        "Url": "https://ark.cn-beijing.volces.com/api/v3/chat/completions",
        "ApiKey": "zego_test", // your api key (zego_test 在接入测试期间(AI Agent 服务开通 2 周内)可使用，详情请查看快速开始说明)
        "Model": "doubao-lite-32k-240828",
        "SystemPrompt": "你是小智，成年女性，是**即构科技创造的陪伴助手**，上知天文下知地理，聪明睿智、热情友善。\n对话要求：1、按照人设要求与用户对话。\n2、不能超过100字。"
    },
    "TTS": {
        "Vendor": "ByteDance",
        "Params": {
            "app": {
                "appid": "zego_test", // your appid (zego_test 在接入测试期间(AI Agent 服务开通 2 周内)可使用，详情请查看快速开始说明)
                "token": "zego_test", // your token (zego_test 在接入测试期间(AI Agent 服务开通 2 周内)可使用，详情请查看快速开始说明)
                "cluster": "volcano_tts"
            },
            "audio": {
                "voice_type": "zh_female_wanwanxiaohe_moon_bigtts" // your voice type
            }
        }
    },
    "ASR": {
        "HotWord": "即构科技|10"
    }
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。0 表示成功，其他值表示失败。如需了解错误码及响应处理建议，请参考返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。

响应示例

Untitled

{
    "Code": 0,
    "Message": "Succeed",
    "RequestId": "1843985617336143872"
}

Copied!