Domain name for API request: iss.intl.tencentcloudapi.com.
Get a list of visual understanding templates.
A maximum of 20 requests can be initiated per second for this API.
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: ListVLTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Name | No | String | Template name, exact match |
| AnalysisMode | No | String | Analysis mode filter, image / video |
| CaptureType | No | String | Screenshot type filter (this parameter is valid only when AnalysisMode=image): realtime/low |
| PageNumber | No | Integer | Page number, which is 1 by default. |
| PageSize | No | Integer | Number of items per page. Default value: 20. Maximum value: 200. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of VLTemplateInfo | Template list |
| TotalCount | Integer | Total quantity. |
| 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. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListVLTemplates
<Common request parameters>
{
"Name": "Bright Kitchen and Transparent Stove Identification Template"
"AnalysisMode": "image",
"CaptureType": "realtime",
"PageNumber": 1,
"PageSize": 20
}{
"Response": {
"Data": [
{
"AIModel": "IVC-G",
"AnalysisMode": "image",
"CreatedAt": "2026-07-27 15:14:28",
"Describe": "Chef's hat and mask recognition"
"ImageConfig": {
"Interval": 10,
"MultiMode": null,
"Type": 1
},
"IsUsed": false,
"Name": "Bright Kitchen Identification Template"
"Prompt": "You are a catering kitchen clothing compliance check model. Check only two items: chef's hat and mask.\n## Compliance standard\n- Chef's hat: worn and completely covers hair (tall hat/hairnet/cloth hat are all compliant); not worn or hair exposed is non-compliance\n- Mask: covers nose bridge to chin (blue/white medical masks and transparent face shields are all compliant); pulled under chin/hanging on ears/covering only mouth is non-compliance\n## Output\nCompact JSON, no markdown/line breaks/spaces.\n- total_staff: int, total number of kitchen staff\n- hat: {\"compliant\":int,\"non_compliant\":int,\"not_wearing\":int}, number of people with compliant/improper/not wearing hats\n- mask: {\"compliant\":int,\"non_compliant\":int,\"not_wearing\":int}, number of people with compliant/improper/not wearing masks",
"Times": [
{
"BeginTime": "00:00:00",
"EndTime": "23:59:59",
"WeekDay": 1
}
],
"UpdatedAt": "2026-07-27 15:14:28",
"VLTemplateId": "VTa911*************************6c2"
}
],
"TotalCount": 1,
"RequestId": "75677860-9600-494e-b0d9-ba61cb74cf4d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.InvalidCaptureType | Invalid screenshot type filter value. Only realtime/low is supported. |
| InvalidParameterValue.InvalidMediaType | Invalid media type |
| InvalidParameterValue.InvalidPageNumber | Invalid PageNumber |
| InvalidParameterValue.InvalidPageSize | Invalid PageSize |
文档反馈