tencent cloud

APIs

DescribeAgentDetail

下载
聚焦模式
字号
最后更新时间: 2026-11-04 21:51:06

1. API Description

Domain name for API request: adp.intl.tencentcloudapi.com.

Query Agent details

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeAgentDetail.
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 No String

Application ID.

AgentId No String

AgentId

3. Output Parameters

Parameter Name Type Description
Agent AgentDetail

Agent information

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.

4. Example

Example1 Get Agent details

Input Example

POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentDetail
<Common request parameters>

{
    "AppId": "20617**********9040",
    "AgentId": "722f****************************5f01"
}

Output Example

{
    "Response": {
        "Agent": {
            "AdvancedConfig": {
                "MaxReasoningRound": 100
            },
            "AgentId": "722fafb7-37b6-4896-ba32-08617e605f01",
            "Instructions": "",
            "Model": {
"Alias": "Zhipu GLM-5.1",
                "ContextWordsLimit": 0,
                "InstructionsWordsLimit": 20000,
                "ModelId": "TCADP/glm-5.1",
                "ModelParameters": {
                    "DeepThinking": "",
                    "MaxTokens": 16384,
                    "ReasoningEffort": "",
                    "ReplyFormat": "",
                    "StopSequenceList": [],
                    "Temperature": 1
                }
            },
            "PluginList": [
                {
                    "AuthConfigStatus": 2,
                    "Config": {
                        "AuthType": 0,
                        "EnableCamRoleAuth": false,
                        "HeaderParameterList": [],
                        "PluginId": "3ad93aae-587e-4bcc-ae07-ad13bfb1aaca",
                        "QueryParameterList": []
                    },
"Description": "Retrieve content from the knowledge base and polish the reply through a large model"
                    "IconUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/plugin_files/%E7%9F%A5%E8%AF%86%E5%BA%93%E9%97%AE%E7%AD%94.png",
                    "McpServer": {
                        "HeaderParameterList": [],
                        "McpServerUrl": "",
                        "QueryParameterList": [],
                        "StreamReadTimeout": 0,
                        "Timeout": 0
                    },
                    "McpTransport": 0,
"Name": "Knowledge Base QA"
                    "Status": 1
                }
            ],
            "SkillList": [
                {
                    "CurrentVersion": "1.0.0",
                    "Description": "Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.",
"DisplayDescription": "Guide users in completing a structured document collaboration workflow. Used when users want to write documents, proposals, technical specifications, decision documents, or similar structured content. This workflow helps users transmit context efficiently, iteratively optimize content, and verify whether the document is suitable for readers. Triggered when users mention writing documents, creating proposals, drafting specifications, or executing similar document tasks.",
"DisplayName": "Document Co-creation"
                    "IconUrl": "",
                    "Location": "/adp/system/.skills/doc-coauthoring/SKILL.md",
                    "Name": "doc-coauthoring",
                    "SkillId": "ceb06595-9cc4-4ffb-a4c7-0413438265c4",
                    "SourceType": 3
                }
            ],
            "ToolList": [
                {
                    "BillingType": 3,
                    "Config": {
"Description": "Large model answers user questions combined with knowledge base content"
                        "HeaderParameterList": [],
                        "InputList": [
                            {
                                "AnyOfList": [],
"Description": "User's query",
                                "Input": {
                                    "InputType": 0
                                },
                                "IsHidden": false,
                                "IsRequired": true,
                                "Name": "Query",
                                "OneOfList": [],
                                "SubParameterList": [],
                                "Type": 0
                            }
                        ],
                        "IsDisabled": false,
                        "OutputList": [
                            {
"Description": "Status code. 0 indicates normal, and a non-zero value indicates an exception."
                                "Name": "Code",
                                "RenderMode": 0,
                                "SubParameterList": [],
                                "Type": 1
                            }
                        ],
                        "PluginId": "3ad93aae-587e-4bcc-ae07-ad13bfb1aaca",
                        "QueryParameterList": [],
                        "ToolId": "0ca8d482-1e77-462b-bc21-807c8f052f69",
                        "ToolSource": 0
                    },
                    "Name": "KnowledgeRetrievalAnswer",
                    "Status": 1,
                    "StreamMode": 1,
                    "ToolAccessMode": 0
                }
            ]
        },
        "RequestId": "20b8a7d2-a190-4b60-b48d-8f322ce2975b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈