List AI agent instances. You can retrieve all instances or filter them by specified conditions.
Operation description
This operation lists AI agent instances. Filter results by agent ID (AIAgentId). Optionally, specify a time range (StartTime and EndTime), the number of results per page (PageSize), and the page number (PageNumber). The response includes each instance’s status, runtime configuration, template configuration, user-defined data, and a download link for the conversation call log.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:ListAIAgentInstance |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AIAgentId |
string |
Yes |
Agent ID. |
39f8e0bc005e4f309379701645f4*** |
| StartTime |
string |
No |
Start time of the query in ISO 8601 format. No default value. |
2023-01-01T00:00:00Z |
| EndTime |
string |
No |
End time of the query in ISO 8601 format. No default value. |
2023-01-02T00:00:00Z |
| PageSize |
integer |
No |
Number of results per page. Default is 10. Valid values: 0 to 100. |
10 |
| PageNumber |
integer |
No |
Page number. Default is 1. Valid values: 1 to 100. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| Instances |
array<object> |
List of agent instance objects. |
|
|
object |
|||
| CallLogUrl |
string |
URL of the call log file. The file contains a JSON-formatted CallLog structure. |
https://example.com/call_logs/12345.json |
| RuntimeConfig | AIAgentRuntimeConfig |
Runtime configuration required by the agent. |
{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}} |
| Status |
string |
Instance status:
Valid values:
|
Finished |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
Template configuration used by the agent instance. |
{"VoiceChat": {"VoiceId": "zhixiaoxia"}} |
| UserData |
string |
User-defined information. |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| AgentConfig | AIAgentConfig |
Template configuration used by the agent instance. |
|
| RequestId |
string |
Request ID. |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
Examples
Success response
JSON format
{
"Instances": [
{
"CallLogUrl": "https://example.com/call_logs/12345.json",
"RuntimeConfig": {
"VoiceChat": {
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
},
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"VisionChat": {
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
},
"ChannelId": "70f22d5784194938a7e387052f2b3208\n",
"AvatarChat3D": {
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
}
},
"Status": "Finished",
"TemplateConfig": {
"VoiceChat": {
"Greeting": "早上好，我的朋友",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"WorkflowOverrideParams": "{}",
"EnableIntelligentSegment": true,
"AvatarUrlType": "USER",
"AvatarUrl": "http://example.com/a.jpg",
"VoiceIdList": [
"zhixiaoxia"
],
"CharBreak": false,
"EnableVoiceInterrupt": true,
"VoiceprintId": "uniqueId",
"GracefulShutdown": false,
"InterruptWords": [
"停止"
],
"UserOnlineTimeout": 60,
"AsrLanguageId": "zh_mandarin",
"UserOfflineTimeout": 5,
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
"BailianAppParams": "{}",
"VadLevel": 11,
"LlmHistoryLimit": 10,
"AsrMaxSilence": 400,
"WakeUpQuery": "今天天气怎么样？",
"Volume": 100,
"VoiceId": "zhixiaoxia",
"UseVoiceprint": false,
"MaxIdleTime": 600,
"AsrHotWords": [
"检查"
],
"EnablePushToTalk": false
},
"VisionChat": {
"Greeting": "早上好，我的朋友！\n",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"WorkflowOverrideParams": "{}",
"EnableIntelligentSegment": true,
"VoiceIdList": [
"zhixiaoxia"
],
"CharBreak": false,
"EnableVoiceInterrupt": true,
"VoiceprintId": "uniqueId",
"GracefulShutdown": false,
"InterruptWords": [
"停止"
],
"UserOnlineTimeout": 60,
"AsrLanguageId": "zh_mandarin",
"UserOfflineTimeout": 5,
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
"BailianAppParams": "{}",
"VadLevel": 0,
"LlmHistoryLimit": 10,
"AsrMaxSilence": 400,
"WakeUpQuery": "今天天气怎么样？",
"Volume": 100,
"VoiceId": "zhixiaoxia",
"UseVoiceprint": false,
"MaxIdleTime": 600,
"AsrHotWords": [
"检查"
],
"EnablePushToTalk": false
},
"AvatarChat3D": {
"Greeting": "早上好，我的朋友！",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"WorkflowOverrideParams": "{}",
"EnableIntelligentSegment": true,
"VoiceIdList": [
"zhixiaoxia"
],
"AvatarId": "1231",
"CharBreak": false,
"EnableVoiceInterrupt": true,
"VoiceprintId": "uniqueId",
"GracefulShutdown": false,
"InterruptWords": [
"停止"
],
"UserOnlineTimeout": 60,
"AsrLanguageId": "zh_mandarin",
"UserOfflineTimeout": 5,
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
"BailianAppParams": "{}",
"VadLevel": 0,
"LlmHistoryLimit": 10,
"AsrMaxSilence": 400,
"WakeUpQuery": "今天天气怎么样？",
"Volume": 100,
"VoiceId": "zhixiaoxia",
"UseVoiceprint": false,
"MaxIdleTime": 600,
"AsrHotWords": [
"检查"
],
"EnablePushToTalk": false
}
},
"UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}",
"AgentConfig": {
"Greeting": "你好",
"WakeUpQuery": "今天天气怎么样？\n",
"MaxIdleTime": 600,
"UserOnlineTimeout": 60,
"UserOfflineTimeout": 5,
"EnablePushToTalk": false,
"GracefulShutdown": true,
"Volume": 100,
"WorkflowOverrideParams": "{}",
"AvatarUrl": "http://example.com/a.jpg\n",
"AvatarUrlType": "USER",
"EnableIntelligentSegment": true,
"AsrConfig": {
"AsrLanguageId": "zh_mandarin",
"AsrMaxSilence": 400,
"AsrHotWords": [
"检查"
],
"VadLevel": 11,
"CustomParams": "mode=fast&sample=16000&format=wav",
"VadDuration": 300
},
"TtsConfig": {
"VoiceId": "longcheng_v2\n\n",
"VoiceIdList": [
"zhixiaoxia"
],
"PronunciationRules": [
{
"Word": "一一零",
"Pronunciation": "幺幺零",
"Type": "replacement"
}
],
"ModelId": "speech-01-turbo",
"LanguageId": "Chinese",
"Emotion": "happy",
"SpeechRate": 1
},
"LlmConfig": {
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"LlmHistoryLimit": 10,
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
"BailianAppParams": "\"{\\\"biz_params\\\":{\\\"user_defined_params\\\":{\\\"your_plugin_id\\\":{\\\"article_index\\\":2}}},\\\"memory_id\\\":\\\"your_memory_id\\\",\\\"image_list\\\":[\\\"https://your_image_url\\\"],\\\"rag_options\\\":{\\\"pipeline_ids\\\":[\\\"your_id\\\"],\\\"file_ids\\\":[\\\"文档ID1\\\",\\\"文档ID2\\\"],\\\"metadata_filter\\\":{\\\"name\\\":\\\"张三\\\"},\\\"structured_filter\\\":{\\\"key1\\\":\\\"value1\\\",\\\"key2\\\":\\\"value2\\\"},\\\"tags\\\":[\\\"标签1\\\",\\\"标签2\\\"]}}\"",
"OpenAIExtraQuery": "api-version=2024-02-01&api-key=sk-xxx",
"LlmCompleteReply": true,
"FunctionMap": [
{
"Function": "hangup",
"MatchFunction": "hangup"
}
],
"OutputMinLength": 5,
"OutputMaxDelay": 2000,
"HistorySyncWithTTS": false
},
"AvatarConfig": {
"AvatarId": "5257"
},
"InterruptConfig": {
"EnableVoiceInterrupt": true,
"InterruptWords": [
"打断一下"
],
"NoInterruptMode": "cache"
},
"VoiceprintConfig": {
"UseVoiceprint": false,
"VoiceprintId": "zhixiaoxia",
"RegistrationMode": ""
},
"TurnDetectionConfig": {
"TurnEndWords": [
"我说完了"
],
"Mode": "Semantic",
"SemanticWaitDuration": -1,
"Eagerness": "High"
},
"ExperimentalConfig": "\"\"",
"VcrConfig": {
"StillFrameMotion": {
"Enabled": false,
"CallbackDelay": 3000
},
"InvalidFrameMotion": {
"Enabled": false,
"CallbackDelay": 3000
},
"PeopleCount": {
"Enabled": false
},
"Equipment": {
"Enabled": false
},
"HeadMotion": {
"Enabled": false
},
"LookAway": {
"Enabled": true
}
},
"AmbientSoundConfig": {
"ResourceId": "f67901c595834************",
"Volume": 50
},
"AutoSpeechConfig": {
"UserIdle": {
"WaitTime": 5000,
"MaxRepeats": 5,
"Messages": [
{
"Text": "您还在吗？",
"Probability": 0.5
}
]
},
"LlmPending": {
"WaitTime": 3000,
"Messages": [
{
"Text": "稍等一下",
"Probability": 0.5
}
]
}
},
"BackChannelingConfigs": [
{
"Enabled": true,
"TriggerStage": "",
"Probability": 0,
"Words": [
{
"Text": "",
"Probability": 0
}
]
}
],
"BackChannelingConfig": [
{
"Enabled": true,
"TriggerStage": "pause_detected",
"Probability": 0.5,
"Words": [
{
"Text": "嗯嗯",
"Probability": 0.3
}
]
}
]
}
}
],
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.