调用API创建AI智能体实例以开启对话-智能媒体服务-阿里云

创建一个智能体实例，返回智能体所在的频道、频道内名称以及进入频道所需的token。

接口说明

通过此 API，您可以根据提供的 AI 智能体 ID（AIAgentId）创建一个智能体实例。您可以通过 API 响应中的信息进入对应房间，与智能体进行对话。

重要确保提供的 AI 智能体 ID 有效，并根据实际应用场景适当配置可选参数。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:GenerateAIAgentCall

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AIAgentId	string	是	智能体 ID。	39f8e0bc005e4f309379701645f4****
Expire	integer	否	可选参数，表示 token 失效的时间，单位秒，默认 3600 秒。取值范围 0~604800。	3600
UserId	string	否	对话频道内用户名称，不输入则系统自动生成。长度不超过 64。	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	否	填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。说明智能体模版配置。已废弃，详见 AgentConfig 字段。
UserData	string	否	用户自定义信息。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	否	对话的唯一标记，默认无。	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	否	智能体模版配置，填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。说明兼容 TemplateConfig 规则：优先使用 AgentConfig 中的字段，如果 TemplateConfig 存在某些字段 AgentConfig 未填写，会使用 TemplateConfig 字段。推荐使用 AgentConfig，不再使用 TemplateConfig。
ChatSyncConfig	object	否	同步聊天记录配置。
IMAIAgentId	string	否	IM 的智能体 Id。	****005e4f309379701645f4**
ReceiverId	string	否	接收用户 Id。	4167626d312034b2b1c3b7f2f3e41884

返回参数

名称	类型	描述	示例值
	object	Schema of Response
AIAgentUserId	string	ARTC 频道内智能体的名称。	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	ARTC 频道 ID。	70f22d5784194938a7e387052f2b3208
InstanceId	string	生成的智能体实例 ID。	39f8e0bc005e4f309379701645f4****
RequestId	string	请求 ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	端侧的 ARTC Token。	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	ARTC 频道内用户名称。	user123

示例

正常返回示例

JSON格式

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。