創建一個智能體實例,返回智能體所在的頻道、頻道內名稱以及進入頻道所需的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 | long | 否 | 可選參數,表示 token 失效的時間,單位秒,默認 3600 秒。取值范圍 0~604800。 | 3600 |
UserId | string | 否 | 對話頻道內用戶名稱,不輸入則系統自動生成。長度不超過 64。 | 877ae632caae49b1afc81c2e8194ffb4 |
TemplateConfig | AIAgentTemplateConfig | 否 | 智能體模版配置。
| |
UserData | string | 否 | 用戶自定義信息。 | {"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
返回參數
示例
正常返回示例
JSON
格式
{
"AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"ChannelId": "70f22d5784194938a7e387052f2b3208",
"InstanceId": "39f8e0bc005e4f309379701645f4****",
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
"Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"UserId": "user123"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。