Domain name for API request: iss.intl.tencentcloudapi.com.
Create a visual understanding template.
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: CreateVLTemplate. |
| 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. |
| AIModel | Yes | String | AI model Enumeration values:
|
| Name | Yes | String | Template name. Supports only Chinese, English, digits, _, and -, with a maximum length of 32 characters. |
| Prompt | Yes | String | Prompt content, maximum 2MB |
| AnalysisMode | Yes | String | Analysis mode Enumeration values:
|
| Times.N | Yes | Array of EffectiveTime | List of effective periods, up to 100 entries |
| Describe | No | String | Template description. Maximum length: 256 characters. |
| ImageConfig | No | ImageSceneInfo | Image scenario configuration (required when AnalysisMode=image) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | VLTemplateInfo | Visual understanding template 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. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVLTemplate
<Common request parameters>
{
"AIModel": "ivc-vl-1.0",
"Name": "Test template",
"Prompt": "What are in the image",
"AnalysisMode": "image",
"Times": [
{
"BeginTime": "00:00:00",
"EndTime": "10:00:00",
"WeekDay": 1
}
],
"ImageConfig": {
"Type": 1,
"Interval": 10
}
}{
"Response": {
"Data": {
"AIModel": "ivc-vl-1.0",
"AnalysisMode": "image",
"CreatedAt": "2026-08-17 17:23:41",
"Describe": "",
"ImageConfig": {
"Interval": 10,
"MultiMode": null,
"Type": 1
},
"Name": "Test template"
"Prompt": "What are in the image",
"Times": [
{
"BeginTime": "00:00:00",
"EndTime": "10:00:00",
"WeekDay": 1
}
],
"UpdatedAt": "2026-08-17 17:23:41",
"VLTemplateId": "VT58c*************************04e3"
},
"RequestId": "1676edea-cb77-4629-968b-197833ba8d87"
}
}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.InvalidAIModel | InvalidParameterValue.InvalidAIModel |
| InvalidParameterValue.InvalidDescribe | Invalid description. |
| InvalidParameterValue.InvalidImageConfigIntervalForLowFreq | The value range of the infrequent frame capturing frequency is [30, 36000] seconds. |
| InvalidParameterValue.InvalidImageConfigIntervalForRealtime | The value range of the real-time frame capturing frequency is [5, 180] seconds. |
| InvalidParameterValue.InvalidImageConfigType | Invalid screenshot type |
| InvalidParameterValue.InvalidMediaType | Invalid media type |
| InvalidParameterValue.InvalidName | Name is empty or incorrect. |
| InvalidParameterValue.InvalidPrompt | Invalid prompt |
| InvalidParameterValue.InvalidTimes | InvalidParameterValue.InvalidTimes |
| InvalidParameterValue.MissingImageConfig | InvalidParameterValue.MissingImageConfig |
| InvalidParameterValue.MissingTimes | InvalidParameterValue.MissingTimes |
文档反馈