Query AI Agent Instance Details with DescribeAIAgentInstance - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries an instance.

Operation description

Description: This operation queries the details of a specified agent instance.
Scenarios: Call this operation to obtain the required data when you need to monitor or analyze the performance of an agent during a call, or debug the configuration of an agent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:DescribeAIAgentInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The agent instance ID. Note InstanceId is the unique ID returned after the agent instance is started successfully. For the operations to start an agent, refer to StartAIAgentInstance and GenerateAIAgentCall.	39f8e0bc005e4f309379701645f4****

Response elements

Element	Type	Description	Example
	object	Schema of Response
Instance	object	The agent instance information.
CallLogUrl	string	The URL of the call log.	https://example.com/call_logs/12345
RuntimeConfig	AIAgentRuntimeConfig	The runtime configuration of the agent.	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Status	string	The status of the agent instance, such as Finished or Executing. Valid values: Finished : finished. Executing : running.	Finished
TemplateConfig `deprecated`	AIAgentTemplateConfig	The template configuration of the agent.	{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}
UserData	string	The custom user information.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	The unique identifier of the conversation. No value by default.	955535**************
AgentConfig	AIAgentConfig	The template configuration of the 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	The PSTN call details. This field may be empty if the call has not ended.
RequestId	string	The request ID.	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Examples

Success response

JSON format

{
  "Instance": {
    "CallLogUrl": "https://example.com/call_logs/12345",
    "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\"}}",
    "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": "4",
      "CallStartTime": "2026-04-01T16:53:53.184797+00:00",
      "CallEndTime": "2026-04-01T16:53:58.875932+00:00",
      "CallDuration": 5,
      "HangupRole": 0,
      "CallerNumber": "183*****333",
      "CalleeNumber": "136******794"
    }
  },
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.