1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
创建视觉理解模板
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateVLTemplate。 |
| Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AIModel | 是 | String | AI 模型 枚举值:
示例值:ivc-vl-1.0 |
| Name | 是 | String | 模板名称,仅支持中文/英文/数字/_/-,最长 32 个字符 示例值:测试模板 |
| Prompt | 是 | String | 提示词,最大 2MB 示例值:图片中有什么 |
| AnalysisMode | 是 | String | 分析模式 枚举值:
示例值:image |
| Times.N | 是 | Array of EffectiveTime | 生效时段列表,最多 100 条 |
| Describe | 否 | String | 模板描述,最长 256 个字符 示例值:厨师帽和口罩识别 |
| ImageConfig | 否 | ImageSceneInfo | 图片场景配置(AnalysisMode=image 时必填) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | VLTemplateInfo | 视觉理解模板信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVLTemplate
<公共请求参数>
{
"AIModel": "ivc-vl-1.0",
"Name": "测试模板",
"Prompt": "图片中有什么",
"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": "测试模板",
"Prompt": "图片中有什么",
"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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidAIModel | InvalidParameterValue.InvalidAIModel |
| InvalidParameterValue.InvalidDescribe | 无效的描述 |
| InvalidParameterValue.InvalidImageConfigIntervalForLowFreq | 低频截帧频率取值范围为[30, 36000]秒 |
| InvalidParameterValue.InvalidImageConfigIntervalForRealtime | 实时截帧频率取值范围为[5, 180]秒 |
| InvalidParameterValue.InvalidImageConfigType | 无效的截图类型 |
| InvalidParameterValue.InvalidMediaType | 无效的媒体类型 |
| InvalidParameterValue.InvalidName | 名称为空或填写有误 |
| InvalidParameterValue.InvalidPrompt | 无效的提示词 |
| InvalidParameterValue.InvalidTimes | InvalidParameterValue.InvalidTimes |
| InvalidParameterValue.MissingImageConfig | InvalidParameterValue.MissingImageConfig |
| InvalidParameterValue.MissingTimes | InvalidParameterValue.MissingTimes |