1. 接口描述
接口请求域名： adp.tencentcloudapi.com 。
获取应用信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApp。 |
| Version | 是 | String | 公共参数，本接口取值：2026-05-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| AppId | 是 | String | 应用ID 示例值：2058***6480 |
| Domain | 否 | Integer | 应用域: ADP_DOMAIN_DEV(1)=开发域, ADP_DOMAIN_PROD(2)=发布域。枚举值: 1:开发域, 2:生产域 示例值：1 |
| FieldMask | 否 | FieldMask | 字段掩码，指定需要返回的字段(Paths为空则返回所有字段)。Paths枚举值：AppConfig(应用配置), SecretInfo(应用密钥信息), ShareUrlInfo(分享链接信息), SpecialStatusInfo(特殊状态信息), SearchResourceStatus(搜索资源状态), SharedKnowledgeList(应用引用的共享知识库列表) |
| StatusType | 否 | Integer | 特殊状态类型(当FieldMask包含SpecialStatusInfo时必填)。枚举值: 1:回滚状态, 2:首次导入状态 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| App | App | 应用详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeApp
查询应用详情
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApp
<公共请求参数>
{
"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": "问答回复",
"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": "艾朵_职业套装_站姿",
"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": "智小柔-聊天女声",
"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": "针对您这个问题，我暂时还无法进行回答，请换一个问题吧。",
"InputBoxConfig": {
"InputBoxButtons": [
1
]
},
"Method": 1,
"RecommendPromptMode": 0
},
"Role": {
"RoleDescription": "我是提示词信息"
}
},
"Greeting": {
"Greeting": "你好欢迎语",
"OpeningQuestionList": [
"我的示例问题"
]
},
"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": "我的智能体应用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"
},
"SharedKnowledgeList": [
{
"KnowledgeId": "204**************76",
"KnowledgeName": "**********423"
}
],
"Status": {
"Status": 2,
"StatusDescription": "运行中"
}
},
"RequestId": "ecb7efc6-5070-4c4b-818d-5110026d5cbe"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
