Retrieves information about a specified AI agent instance.
Operation description
Description: Retrieves detailed information for a specific AI agent instance.
Use cases: Use this operation to monitor or analyze the performance of an AI agent during a call, or to debug its configuration.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:DescribeAIAgentInstance |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the AI agent instance. Note
The |
39f8e0bc005e4f309379701645f4**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| Instance |
object |
Information about the AI agent instance. |
|
| CallLogUrl |
string |
The URL of the call log. |
https://example.com/call_logs/12345 |
| RuntimeConfig | AIAgentRuntimeConfig |
The runtime configuration of the AI agent. |
{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}} |
| Status |
string |
The status of the AI agent instance, such as Valid values:
|
Finished |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
The AI agent template configuration. |
{"VoiceChat": {"AppId": "your_voice_chat_app_id"}} |
| UserData |
string |
The user data. |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| SessionId |
string |
The session ID for the conversation. This parameter is empty by default. |
955535************** |
| AgentConfig | AIAgentConfig |
The configuration of the AI agent. |
|
| GmtCreate |
string |
The creation time (UTC). |
2025-07-18T06:39:08.000+00:00 |
| GmtModified |
string |
The modification time (UTC). |
2025-07-18T06:40:12.000+00:00 |
| CallInfo | AIAgentCallInfo |
Information about the call. |
|
| RequestId |
string |
The request ID. |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
Examples
Success response
JSON format
{
"Instance": {
"CallLogUrl": "https://example.com/call_logs/12345",
"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\"}}",
"SessionId": "955535**************",
"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
}
]
}
]
},
"GmtCreate": "2025-07-18T06:39:08.000+00:00",
"GmtModified": "2025-07-18T06:40:12.000+00:00",
"CallInfo": {
"Status": "",
"CallStartTime": "",
"CallEndTime": "",
"CallDuration": 0,
"HangupRole": 0,
"CallerNumber": "",
"CalleeNumber": ""
}
},
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.