tencent cloud

DescribeApp
Last updated:2025-10-30 21:49:07
DescribeApp
Last updated: 2025-10-30 21:49:07

1. API Description

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

This API is used to obtain application details under the corporate.

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: DescribeApp.
Version Yes String Common Params. The value used for this API: 2023-11-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta.
AppBizId Yes String Application ID.
AppType No String Application type; knowledge_qa - knowledge Q&A management; summary - knowledge summary; classifys - knowledge label extraction.
IsRelease No Boolean Whether it is the configuration after release.

3. Output Parameters

Parameter Name Type Description
AppBizId String Application ID.
AppType String Application type; knowledge_qa - knowledge Q&A management; summary - knowledge summary; classifys - knowledge label extraction.
AppTypeDesc String Application type description.
BaseConfig BaseConfig Application type description.
AppConfig AppConfig Application configuration.
AvatarInAppeal Boolean Whether the avatar is under appeal.
RoleInAppeal Boolean Whether the role description is under appeal.
NameInAppeal Boolean Whether the name is under appeal.
GreetingInAppeal Boolean Whether the welcome words are under appeal.
BareAnswerInAppeal Boolean Whether the response message for unknown questions is under appeal.
AppKey String App key of the application.
AppStatus Integer Application status. 1: offline; 2: running; 3: disabled.
AppStatusDesc String Status description.
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 DescribeApp

Obtain application details under the corporate

Input Example

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

{
    "AppBizId": "Application ID"
    "AppType": "knowledge_qa"
}

Output Example

{
    "Response": {
        "AppBizId": "Application ID"
        "AppConfig": {
            "KnowledgeQa": {
                "Greeting": "Welcome words"
                "Model": {
                    "AliasName": "Fine-tuned Knowledge Large Model - Premium"
                    "ContextLimit": 0,
                    "Desc": "Application description"
                    "HistoryLimit": 5,
                    "IsUseContext": true,
                    "Name": "cs-normal-70b",
                    "TokenBalance": 0,
                    "Temperature": "0.5",
                    "TopP": "0.5"
                },
                "Output": {
                    "Conservative response"
                    "Method": 1,
                    "QuestionClarifyKeywords": [],
                    "ShowQuestionClarify": false,
                    "UseGeneralKnowledge": true,
                    "UseQuestionClarify": false,
                    "UseRecommended": false
                },
                "Pattern": "standard",
                "Plugins": [
                    {
                        "Inputs": [
                            {
                                "DefaultValue": "",
                                "Desc": "User's query"
                                "IsRequired": true,
                                "Name": "Query",
                                "SubParams": [],
                                "Type": 0
                            }
                        ],
                        "IsBindingKnowledge": true,
                        "PluginIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/plug-in.png"
                        "PluginId": "3ad9ddae-587e-4bcc-ae07-ad13bfb1aaca",
                        "PluginName": "Knowledge library Q&A"
"ToolDesc": "The large model answers user questions by integrating contents in the knowledge library".                        "ToolId": "0ca8d482-1e77-462b-bc21-xddd7c8f052f69",
                        "ToolName": "KnowledgeRetrievalAnswer"
                    }
                ],
                "RoleDescription": "Role description"
                "Search": [
                    {
                        "Confidence": 0.7,
                        "DocTopN": 0,
                        "IsEnabled": true,
                        "QaTopN": 3,
                        "ReplyFlexibility": 1,
                        "ResourceStatus": 0,
                        "ShowSearchEngine": false,
                        "Type": "qa",
                        "UseSearchEngine": false
                    },
                    {
                        "Confidence": 0,
                        "DocTopN": 0,
                        "IsEnabled": false,
                        "QaTopN": 0,
                        "ReplyFlexibility": 0,
                        "ResourceStatus": 0,
                        "ShowSearchEngine": false,
                        "Type": "search",
                        "UseSearchEngine": false
                    },
                    {
                        "Confidence": 0.2,
                        "DocTopN": 5,
                        "IsEnabled": true,
                        "QaTopN": 0,
                        "ReplyFlexibility": 0,
                        "ResourceStatus": 0,
                        "ShowSearchEngine": false,
                        "Type": "doc",
                        "UseSearchEngine": false
                    },
                    {
                        "Confidence": 0,
                        "DocTopN": 0,
                        "IsEnabled": false,
                        "QaTopN": 0,
                        "ReplyFlexibility": 0,
                        "ResourceStatus": 0,
                        "ShowSearchEngine": false,
                        "Type": "taskflow",
                        "UseSearchEngine": false
                    }
                ],
                "SearchRange": {
                    "ApiVarAttrInfos": [
                        {
                            "ApiVarId": "Custom variable ID"
                            "AttrBizId": "Label ID"
                        }
                    ],
                    "Condition": "and"
                },
                "Workflow": {
                    "IsEnabled": true,
                    "UsePdl": false
                },
                "SearchStrategy": {
                    "StrategyType": 0,
                    "TableEnhancement": false
                },
                "SingleWorkflow": {
                    "IsEnable": false,
                    "Status": "Single workflow status"
                    "WorkflowDesc": "Single workflow description"
                    "WorkflowId": "Single workflow ID"
                    "WorkflowName": "Single workflow name"
                },
                "ThoughtModel": {
                    "AliasName": "Fine-tuned Function-call Model"
                    "ContextLimit": 0,
                    "Desc": "",
                    "HistoryLimit": 0,
                    "IsUseContext": false,
                    "Name": "function-call-pro",
                    "Temperature": "0.5",
                    "TokenBalance": 0,
                    "TopP": "0.5"
                }
            }
        },
        "AppKey": "Application secret key"
        "AppStatus": 2,
        "AppStatusDesc": "running"
        "AppType": "knowledge_qa",
        "AppTypeDesc": "Knowledge library Q&A"
        "AvatarInAppeal": false,
        "BareAnswerInAppeal": false,
        "BaseConfig": {
            "Avatar": "Avatar"
            "Desc": "",
            "Name": "My Intelligent Application"
        },
        "GreetingInAppeal": false,
        "NameInAppeal": false,
        "RequestId": "485126ca-468c-497b-ab96-b939a8e125bd",
        "RoleInAppeal": false
    }
}

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.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback