tencent cloud

DescribeRefer
Last updated: 2025-10-30 21:48:55
DescribeRefer
Last updated: 2025-10-30 21:48:55

1. API Description

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

This API is used to get the reference source details list.

A maximum of 100 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: DescribeRefer.
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.
BotBizId Yes String Application ID
ReferBizIds.N Yes Array of String Quota ID
LoginUin No String Log in to the user's root account (required in the integrator mode).
LoginSubAccountUin No String Login user sub-account (required in integrator mode).

3. Output Parameters

Parameter Name Type Description
List Array of ReferDetail Reference list.
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 Query the Detail of Reference Source

Query the detail of reference source

Input Example

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

{
    "BotBizId": "1696822786072117248",
    "ReferBizIds": [
        "1694302461379890134"
    ]
}

Output Example

{
    "Response": {
        "List": [
            {
                "Answer": "",
                "Confidence": 0.9336649,
                DocName": "Deep Sea Ashes.txt
                "DocType": 2,
                "Highlights": [],
                "Mark": 1,
                OrgData": "Deep Sea Ashes: No one would have thought that Anomaly 001 would have problems one day, just as no one considered whether the boundless sea would dry up one day. But now it seems that this "eternal" sun is not really eternal. First, the sunrise was delayed by fifteen minutes, and then there was a barely visible gap on the rune circle... These disturbing pieces of information all indicate one thing: the lifetime of Anomaly 001 is finite! Duncan stood by the showcase, silently watching the bright sunlight illuminate the streets, while his mind was in turmoil like a storm. He was not the only one who noticed the sun's anomaly. There are many smart people in the world. Ordinary people may not pay attention to the changes above their heads, but the authorities of each city-state and the church must have someone constantly monitoring the world's largest anomaly. Now, someone must have noticed the change in the sun... What will they think? How will they respond? Does anyone know what happened?
                PageContent": "The Abyssal Embers: No one would have thought that Anomaly 001 would have problems one day, just as no one considered whether the boundless sea would dry up one day. But now it seems that this 'eternal' sun is not really eternal. First, the sunrise was delayed by fifteen minutes, and then there was the barely visible gap on the rune circle... These disturbing pieces of information all indicate one thing: the lifetime of Anomaly 001 is actually finite! Duncan stood beside the showcase, silently watching the bright daylight illuminate the streets, while his mind was in turmoil like a storm. It's not only himself who noticed the sun's anomaly. There are many smart people in the world. Ordinary people may not pay attention to the changes above their heads, but the authorities of various city-states and the church must have someone constantly monitoring the largest anomaly in the world. Now, someone should have noticed the change in the sun... What will they think? How will they respond? Does anyone know what happened?
                "Question": "",
                "SheetInfos": [],
                "PageInfos": [
                    1
                ],
                "ReferBizId": "1694302461379890134"
            }
        ],
        "RequestId": "73e3226c-b180-4b21-923b-2bfcc47b96bc"
    }
}

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