Domain name for API request: adp.intl.tencentcloudapi.com.
This API is used to obtain application information.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeApp. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AppId | Yes | String | Application ID. |
| Domain | No | Integer | Application domain: ADP_DOMAIN_DEV(1)=development domain, ADP_DOMAIN_PROD(2)=release domain. Enumeration values: 1: development domain, 2: production domain |
| FieldMask | No | FieldMask | Field mask, specify the fields to return (return all fields if Paths is empty). Paths enumeration values: AppConfig (application configuration), SecretInfo (application key info), ShareUrlInfo (sharing link information), SpecialStatusInfo (special status information), SearchResourceStatus (search resource status), SharedKbList (list of shared knowledge bases referenced by the application), CorpShareConfig (corporate shared configuration), FileVolumeMountList (cloud disk mount list) |
| StatusType | No | Integer | Specific status type (required when FieldMask includes SpecialStatusInfo). Enumeration values: 1: rollback status, 2: first-time import status |
| Parameter Name | Type | Description |
|---|---|---|
| App | App | App details |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This API is used to query details of an application.
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApp
<Common request parameters>
{
"AppId": "20**************184",
"Domain": 1,
"FieldMask": {
"Paths": [
"AppConfig"
]
},
"StatusType": 1
}{
"Response": {
"App": {
"AuxiliaryInfo": {
"Appeal": {
"AppealingStatus": {
"AvatarInAppeal": false,
"FallbackReplyInAppeal": false,
"GreetingInAppeal": false,
"NameInAppeal": false,
"RoleInAppeal": false
}
},
"SearchResourceStatus": {
"ResourceStatus": 1
},
"SpecialStatusInfo": {
"Status": 0
},
"SubStatus": {
"ApprovalId": "0",
"SubStatusList": []
},
"TemplatePublish": {
"IsPublished": false
}
},
"Config": {
"Experience": {
"Advanced": {
"EnableContextRewrite": true,
"EnableImageTextRetrieval": false,
"IntentAchievement": [
{
"Description": "QA reply",
"Name": "qa"
}
],
"ReplyFlexibility": 1
},
"Conversation": {
"AiCall": {
"DigitalHuman": {
"AssetKey": "df************************ddadf0",
"Avatar": "https://virtualhuman-cos-prod-1251316161.cos.ap-nanjing.tencentcos.cn/wupload/xy/virtualhuman_crm_prod/website_buy/vnZ6ZZYY.png",
"Name": "Aiduo_Professional Suit_Standing Pose",
"PreviewUrl": "https://virtualhuman-cos-prod-1251316161.cos.ap-nanjing.tencentcos.cn/wupload/xy/virtualhuman_crm_prod/preview/vStr966G.png"
},
"EnableDigitalHuman": true,
"EnableVoiceCall": true,
"EnableVoiceInteract": true,
"Voice": {
"TimbreKey": "tts_female_55",
"VoiceName": "Zhixiaorou - Chatting Female Voice",
"VoiceType": 502001
}
},
"BackgroundImage": {
"Brightness": 117,
"LandscapeImageUrl": "https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/public/1744544193038090240/2060280711767285184/image/xdNgbZYwoJkwclZytKaa-2061707216749939200.jpg",
"OriginalImageUrl": "https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/public/1744544193038090240/2060280711767285184/image/xdNgbZYwoJkwclZytKaa-2061707216749939200.jpg",
"PortraitImageUrl": "https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/public/1744544193038090240/2060280711767285184/image/xdNgbZYwoJkwclZytKaa-2061707216749939200.jpg",
"ThemeColor": "#cc5631"
},
"EnableFallbackReply": true,
"EnableRecommended": true,
"EnableWebSearch": false,
"FallbackReply": "I'm temporarily unable to answer this question. Please try another one.",
"InputBoxConfig": {
"InputBoxButtons": [
1
]
},
"Method": 1,
"RecommendPromptMode": 0
},
"Role": {
"RoleDescription": "I am prompt content"
}
},
"Greeting": {
"Greeting": "Hello welcome message",
"OpeningQuestionList": [
My example question
]
},
"Memory": {
"Enabled": true,
"LongMemoryDay": 30,
"Model": {
"Alias": "DeepSeek-V3.2",
"HistoryLimit": 5,
"ModelId": "Deepseek/deepseek-v3.2",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 16384,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.6,
"TopP": 0.6
}
},
"PromptContent": "",
"PromptMode": 0
},
"Mode": {},
"Model": {
"AiOptimizeModel": {
"Model": {
"Alias": "youtu-mrc-standard",
"HistoryLimit": 0,
"ModelId": "Youtu/youtu-mrc-standard",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4000,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.7,
"TopP": 0.6
}
}
},
"FileParseModel": {
"Alias": "youtu-parsing-sync",
"Description": "",
"EnhancementMode": "",
"ModelId": "Youtu/youtu-parsing-sync",
"ModelProviderType": "",
"SupportedFileList": []
},
"GenerateModel": {
"Model": {
"Alias": "youtu-mrc-pro",
"HistoryLimit": 5,
"ModelId": "Youtu/youtu-mrc-pro",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4000,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.7,
"TopP": 0.6
}
}
},
"MultiModalQaModel": {
"Model": {
"Alias": "hunyuan-turbos-vision",
"HistoryLimit": 5,
"ModelId": "Hunyuan/hunyuan-turbos-vision",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4096,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.7,
"TopP": 0.6
}
}
},
"MultiModalUnderstandingModel": {
"Model": {
"Alias": "youtu-mllm",
"HistoryLimit": 5,
"ModelId": "Youtu/youtu-mllm",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4000,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.7,
"TopP": 0.6
}
}
},
"PromptRewriteModel": {
"Model": {
"Alias": "youtu-rewrite",
"HistoryLimit": 5,
"ModelId": "Youtu/youtu-rewrite",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4000,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0.6,
"TopP": 0.9
}
}
},
"ThinkModel": {
"Model": {
"Alias": "youtu-intent-pro",
"HistoryLimit": 5,
"ModelId": "Youtu/youtu-intent-pro",
"ModelParams": {
"DeepThinking": "",
"MaxTokens": 4000,
"ReasoningEffort": "",
"ReplyFormat": "",
"StopSequenceList": [],
"Temperature": 0,
"TopP": 0.8
}
}
}
},
"WebSearch": {
"ApiKey": "",
"Enabled": false,
"Provider": "",
"TopN": 0
},
"Workflow": {
"EnablePDL": false
}
},
"Metadata": {
"AppId": "2060280711767285184",
"AppMode": 1,
"Avatar": "https://cdn.xiaowei.qq.com/static/adp/app-default-avatar.png",
"CreateTime": "1780044175",
"Description": "",
"Name": "My Intelligent Agent Application 03",
"SpaceId": "default_space",
"UpdateTime": "1780384282"
},
"SecretInfo": {
"AppKey": "cwwjX**************************************************************************************c************************nptQWMSAtFeD",
"CreateTime": "1780044174"
},
"ShareUrlInfo": {
"AccessControl": {
"AccessType": 3,
"Enabled": true,
"Whitelist": [
{
"Type": 1,
"Values": [
"70000000"
]
}
]
},
"ShareUrl": "https://tde.xiaowei.cloud.tencent.com/webim_exp/#/chat/leSlPm"
},
"Status": {
"Status": 2,
"StatusDescription": "running"
}
},
"RequestId": "ecb7efc6-5070-4c4b-818d-5110026d5cbe"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback