本文为您介绍AUI Kits智能体实时互动场景的API说明。
创建客户智能体实例
创建一个客户的智能体实例，适用于AICallKit SDK集成方案和ARTC SDK集成方案。
使用说明
请求协议：http/https
请求Path：/api/v1/aiagent/GenerateAIAgentCall
是否需要授权：是
请求Method：POST
请求ContentType：JSON
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_id | String | 否 | 39f8e0bc005e4f309379701645f4**** | 智能体ID | |||
expire | integer | 否 | 24 | 可选参数，表示token失效的时间，单位，默认24小时 | |||
user_id | String | 否 | useridxxxx | 用户id | |||
template_config | String | 是 | {"VoiceChat": {"AppId": "your_voice_chat_app_id"}} | AIAgent模板配置 | |||
workflow_type | String | 否 | VoiceChat | 智能体实例类型：
| |||
返回数据
名称 | 类型 | 示例值 | 描述 | ||||
code | Integer | 200 | 业务响应码。参考HTTP响应码 | ||||
rtc_auth_token | String | rtc_auth_tokenxxx | RTC 授权token, 经过base64编码 | ||||
ai_agent_id | String | ai_agent_idxxxx | 智能体id | ||||
ai_agent_user_id | String | ai_agent_user_idxxxx | 智能体用户id | ||||
channel_id | String | channel_idxxxx | 频道id | ||||
workflow_type | String | VoiceChat | 智能体实例类型 | ||||
ai_agent_instance_id | String | ai_agent_instance_idxxx | 智能体实例ID | ||||
示例
请求示例
{
"ai_agent_id":"30040ed7740b42f4a944bf6xxxxx",
"expire": 24,
"user_id": "12345678xxxx",
"template_config":"{}",
"workflow_type": "VoiceChat"
}正常返回示例
{
"code": 200,
"rtc_auth_token": "eyJnc2xiIjpbImh0dHBzOi8vZ3cucnRuLmFsaXl1bmxxxxx",
"ai_agent_user_id":"xxx",
"channel_id": "fwfwqeqeqwewqxxx",
"workflow_type": "VoiceChat",
"ai_agent_id": "17e1c928bead40afb36f861d44c2fa0axxx",
"ai_agent_instance_id": "abcb1f5177b449329144b5f6578xxxx"
}启动智能体实例
启动一个RTC互动AI智能体实例，并加入RTC通话，适用于ARTC SDK集成方案。
使用说明
请求协议：http/https
请求Path：/api/v1/aiagent/startAIAgentInstance
是否需要授权：是
请求Method：POST
请求ContentType：JSON
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 | |||
user_id | String | 是 | useridxxxx | 用户id | |||
template_config | String | 否 | {"xxx":"xx"} | AIAgent模板配置 | |||
workflow_type | String | 是 | VoiceChat | 智能体实例类型：
| |||
返回数据
名称 | 类型 | 示例值 | 描述 | ||||
code | Integer | 200 | 业务响应码。参考HTTP响应码 | ||||
ai_agent_instance_id | String | 513bbc1a2672*****1e2be | 智能体实例id | ||||
rtc_auth_token | String | xxxx | RTC 授权token, 经过base64编码 | ||||
ai_agent_user_id | String | xxxx | 智能体用户id | ||||
channel_id | String | xxxx | 频道id | ||||
示例
请求示例
{
"workflow_type":"VoiceChat",
"user_id": "12345xxxx",
"template_config":""
}正常返回示例
{
"code": 200,
"rtc_auth_token": "eyJnc2xiIjpbImh0dHBzOixxxx",
"ai_agent_instance_id": "30040ed7740b42f4a944bf6f5bxxx",
"ai_agent_user_id": "97fcfc0b6dc74601903e570c6a82xxx",
"channel_id": "5abcd61c4fa24ed79dc7c1cb4a64xxxx"
}停止智能体实例
停止一个RTC互动AI智能体实例，适用于ARTC SDK集成方案。
使用说明
请求协议：http/https
请求Path：/api/v1/aiagent/stopAIAgentInstance
是否需要授权：是
请求Method：POST
请求ContentType：JSON
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_instance_id | String | 是 | 513bbc1a2672*****1e2be | 需要停止的智能体实例ID | |||
返回数据
名称 | 类型 | 示例值 | 描述 | ||||
code | Integer | 200 | 业务响应码。参考HTTP响应码 | ||||
result | boolean | true | 结果：true-成功；false-失败 | ||||
示例
请求示例
{
"ai_agent_instance_id": "ff22f767-0471-4ef4-8aee-2xxxxxx"
}正常返回示例
{
"code": "200",
"result": true
}修改智能体实例配置
修改一个RTC互动AI智能体实例配置，如音色、欢迎语等，适用于ARTC SDK集成方案。
使用说明
请求协议：http/https
请求Path：/api/v1/aiagent/updateAIAgentInstance
是否需要授权：是
请求Method：POST
请求ContentType：JSON
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 | |||
ai_agent_instance_id | String | 是 | 513bbc1a2672*****1e2be | 需要修改智能体实例ID | |||
template_config | String | 是 | {"xxx":"xx"} | AIAgent模板配置 | |||
返回数据
名称 | 类型 | 示例值 | 描述 | ||||
code | 200 | 业务响应码。参考HTTP响应码 | 业务响应码。参考HTTP响应码 | ||||
result | true | true | 结果：true-成功；false-失败 | ||||
示例
请求示例
{
"ai_agent_instance_id": "513bbc1a2672667bxxxx33b8fa0c9a88xxxxxx",
"template_config": "{\"xxx\":\"xxxx\"}"
}正常返回示例
{
"code": "200",
"result": true
}