Queries the list of AI agent instances. You can retrieve all instances or filter by specified conditions.
Operation description
This operation allows you to query the list of AI agent instances based on the specified agent ID (AIAgentId), along with optional parameters such as time range (StartTime and EndTime), page size (PageSize), and page number (PageNumber). The response includes the status, runtime configuration, template configuration, user-defined data, and download URL for conversation call logs of each instance.
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 |
The agent ID. |
39f8e0bc005e4f309379701645f4*** |
| StartTime |
string |
No |
The start time of the query in ISO 8601 format. No default value. |
2023-01-01T00:00:00Z |
| EndTime |
string |
No |
The end time of the query in ISO 8601 format. No default value. |
2023-01-02T00:00:00Z |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Valid values: 0 to 100. |
10 |
| PageNumber |
integer |
No |
The page number. Default value: 1. Valid values: 1 to 100. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| Instances |
array<object> |
The list of agent instance structs. |
|
|
object |
|||
| CallLogUrl |
string |
The URL of the agent conversation call log file. The file contains the CallLog struct in JSON format. |
https://example.com/call_logs/12345.json |
| RuntimeConfig | AIAgentRuntimeConfig |
The runtime configuration required by the agent. |
{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}} |
| Status |
string |
The instance status. Valid values:
Valid values:
|
Finished |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
The template configuration used by the agent instance. |
{"VoiceChat": {"VoiceId": "zhixiaoxia"}} |
| UserData |
string |
The user-defined data. |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| AgentConfig | AIAgentConfig |
The template configuration used by the agent instance. |
|
| RequestId |
string |
The request ID. |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
Examples
Success response
JSON format
{
"Instances": [
{
"CallLogUrl": "https://example.com/call_logs/12345.json",
"RuntimeConfig": {
"AvatarChat3D": {
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
},
"VisionChat": {
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
},
"VoiceChat": {
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"ChannelId": "70f22d5784194938a7e387052f2b3208"
},
"AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"ChannelId": "70f22d5784194938a7e387052f2b3208\n"
},
"Status": "Finished",
"TemplateConfig": {
"AvatarChat3D": {
"AsrMaxSilence": 400,
"AvatarId": "1231",
"EnableIntelligentSegment": true,
"EnablePushToTalk": false,
"EnableVoiceInterrupt": true,
"GracefulShutdown": false,
"Greeting": "早上好，我的朋友！",
"UseVoiceprint": false,
"UserOnlineTimeout": 60,
"VoiceId": "zhixiaoxia",
"Volume": 100,
"VoiceprintId": "uniqueId",
"BailianAppParams": "{}",
"UserOfflineTimeout": 5,
"MaxIdleTime": 600,
"WorkflowOverrideParams": "{}",
"WakeUpQuery": "今天天气怎么样？",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"LlmHistoryLimit": 10,
"VoiceIdList": [
"zhixiaoxia"
],
"AsrLanguageId": "zh_mandarin",
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
"InterruptWords": [
"停止"
],
"VadLevel": 0,
"CharBreak": false,
"AsrHotWords": [
"检查"
]
},
"VisionChat": {
"AsrMaxSilence": 400,
"EnableIntelligentSegment": true,
"EnablePushToTalk": false,
"EnableVoiceInterrupt": true,
"GracefulShutdown": false,
"Greeting": "早上好，我的朋友！\n",
"UseVoiceprint": false,
"UserOnlineTimeout": 60,
"VoiceId": "zhixiaoxia",
"Volume": 100,
"VoiceprintId": "uniqueId",
"BailianAppParams": "{}",
"UserOfflineTimeout": 5,
"MaxIdleTime": 600,
"WorkflowOverrideParams": "{}",
"WakeUpQuery": "今天天气怎么样？",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"LlmHistoryLimit": 10,
"VoiceIdList": [
"zhixiaoxia"
],
"AsrLanguageId": "zh_mandarin",
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
"InterruptWords": [
"停止"
],
"VadLevel": 0,
"CharBreak": false,
"AsrHotWords": [
"检查"
]
},
"VoiceChat": {
"AsrMaxSilence": 400,
"EnableIntelligentSegment": true,
"EnablePushToTalk": false,
"EnableVoiceInterrupt": true,
"GracefulShutdown": false,
"Greeting": "早上好，我的朋友",
"UseVoiceprint": false,
"UserOnlineTimeout": 60,
"VoiceId": "zhixiaoxia",
"Volume": 100,
"VoiceprintId": "uniqueId",
"BailianAppParams": "{}",
"UserOfflineTimeout": 5,
"AvatarUrl": "http://example.com/a.jpg",
"AvatarUrlType": "USER",
"MaxIdleTime": 600,
"WorkflowOverrideParams": "{}",
"WakeUpQuery": "今天天气怎么样？",
"LlmHistory": [
{
"Role": "user",
"Content": "你好"
}
],
"LlmHistoryLimit": 10,
"VoiceIdList": [
"zhixiaoxia"
],
"AsrLanguageId": "zh_mandarin",
"LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
"InterruptWords": [
"停止"
],
"VadLevel": 11,
"CharBreak": false,
"AsrHotWords": [
"检查"
]
}
},
"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",
"KeepInterruptWordsForLLM": true
},
"VoiceprintConfig": {
"UseVoiceprint": false,
"VoiceprintId": "zhixiaoxia",
"RegistrationMode": "Explicit"
},
"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
}
],
"HangupEndWord": "我挂了，再见"
},
"LlmPending": {
"WaitTime": 3000,
"Mode": "",
"Messages": [
{
"Text": "稍等一下",
"Probability": 0.5
}
]
}
},
"BackChannelingConfigs": [
{
"Enabled": true,
"TriggerStage": "pause_detected",
"Probability": 0.5,
"Words": [
{
"Text": "嗯嗯",
"Probability": 0.3
}
]
}
],
"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.