tencent cloud

1. API Description

Domain name for API request: iai.tencentcloudapi.com.

This API is used to create an empty group. If the group already exists, an error will be returned.
Custom description fields can be created as needed to describe persons in the group.

A maximum of 100,000 groups or 50 million faces can be created under one APPID.

The maximum number of faces that can be included in one group varies by algorithm model version (FaceModelVersion), which is 1 million for v2.0 or 3 million for v3.0.

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.

3. Output Parameters

4. Example

Example1 Creating group

This example shows you how to create groups.

Input Example

https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=Tencent Shenzhen Employee Group
&FaceModelVersion=3.0
&GroupId=TencentShenZhenEmployee
&Tag=Excludes interns
&GroupExDescriptions.0=Business Group
&GroupExDescriptions.1=Department name
&GroupExDescriptions.2=Group name
&<Common request parameters>

Output Example

{
    "Response": {
        "FaceModelVersion": "3.0",
        "RequestId": "e53ee4ec-9099-4b35-a129-21dd4820ff85"
    }
}

Example2 Creating group - 2

Input Example

https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=Building 1, Zhuyuan Dormitory of XXX University
&GroupId=ZhuYuanDormitoryNo1
&FaceModelVersion=3.0
&Tag=All are girls
&GroupExDescriptions.0=School name
&GroupExDescriptions.1=Major
&GroupExDescriptions.2=Grade
&GroupExDescriptions.3=Student ID
&<Common request parameters>

Output Example

{
    "Response": {
        "FaceModelVersion": "3.0",
        "RequestId": "1695f3dd-b668-479e-8b87-f37de371a8ec"
    }
}

Example3 Sample error

This example shows the error that will occur if a group ID already exists.

Input Example

https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=Tencent Shenzhen Employee Group
&GroupId=TencentShenZhenEmployee
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "76ec6e41-37d6-4ab9-abef-48ef0c6ab175"
    }
}

Example4 Sample error - 2

This example shows the error that will occur if there are Chinese characters in a group ID.

Input Example

https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=Tencent Shenzhen Employee Group
&GroupId=Tencent Employees in Shenzhen
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "8125dda4-2905-4e02-88bd-79a93a660ad2"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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