tencent cloud

APIs

DescribeAigcFaceInfo

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-19 15:01:50

1. API Description

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

This API is used to obtain AIGC face information. Note that calling this API will incur face recognition fees. Refer to the billing documentation (https://www.tencentcloud.com/document/product/266/95125?from_cn_redirect=1#96b3b59a-f9e1-49e9-966a-bedb70a4bf12).

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: DescribeAigcFaceInfo.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId Yes Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
FileInfos.N No Array of AigcFaceInputFileInfo Need to get the input video information for face information, containing at most one file.

3. Output Parameters

Parameter Name Type Description
FaceInfoSet Array of AigcFaceInfo Face 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 Retrieve face information

Input Example

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

{
    "SubAppId": 251007502,
    "FileInfos": [
        {
            "Type": "Url",
            "Url": "https://150*************myqcloud.com/a288b1b2vodtran*************/ee8d47************700322201/v.f100020.mp4"
        }
    ]
}

Output Example

{
    "Response": {
        "FaceInfoSet": [
            {
                "FaceInfoList": [
                    {
                        "EndTime": 8300,
                        "FaceId": "0",
                        "FaceImage": "https://p4-***********.com/ksc2/PwuLBM-5dzj_j1G7Rknhv_y0AJnN3Dbcc_OLXsEBfQbx7bGOUdOVBuJ5wKif7oKOSiGyDYi2lVSohyo-lUOJfNI-9BloWg0hz-hQ4Kprbl8.jpg?cacheKey=ChtzZWN1cml0eS5rbGluZy5tZXRhX2VuY3J5cHQSYIQuk1zV3s4miMifxDwaHLonhr-U2j-wtS1-Rh1DG9rNFOY184QrnGDu-OtDbWejcQcX6C_j8ymp3g8vCLmZitMpyyA9ayaYeYVuPWEKG_hTFaby9KV9xh7o-Dw_yzSrhhoSI394zzPJZ_uhWSjkByU4CYy1IiAmL-aebPeMm7WkoDpRUJQS1q1nmIauc4OI_7ly72QRXygFMAE&x-kcdn-pid=112757&pkey=AAUchViCWGXo5LLMOiMgoZSHnS5dHjJ529n4C4o-4lHRPI9ArlFppz7ON5xvp1NZKaciNO0puXbdtPUqq3Y1Lryw55fANTDmMO8vkVcxGKevc-Ros3qJD1rGJlarXjnqkks",
                        "StartTime": 0
                    }
                ],
                "SessionId": "845692****60512089"
            }
        ],
        "RequestId": "509ed24c-7a76-4328-98b2-a8e2428dd858"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue.FileId The FileId does not exist.
InvalidParameterValue.SubAppId Incorrect parameter value: application id.
UnauthorizedOperation Unauthorized operation.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan