1. 接口描述
接口请求域名： trro.tencentcloudapi.com 。
提交单个视频创建标注任务。支持 S3兼容 存储与 HTTP URL 两种输入源；通过后任务异步执行。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateVideoAnnotationJob。 | ||||||||||||||||||||||||||||||||
| Version | 是 | String | 公共参数，本接口取值：2022-03-25。 | ||||||||||||||||||||||||||||||||
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 | ||||||||||||||||||||||||||||||||
| InputType | 是 | Integer | 输入源类型：1 S3 兼容存储，2 HTTP URL 枚举值：
示例值：1 |
||||||||||||||||||||||||||||||||
| AnnotationType | 是 | Integer | 标注模式（当前仅开放精标注） 枚举值：
示例值：3 |
||||||||||||||||||||||||||||||||
| S3SourceInfo | 否 | S3SourceInfo | S3 存储输入源信息，InputType=1 时必填 |
||||||||||||||||||||||||||||||||
| HttpUrl | 否 | String | 视频 HTTP URL。InputType=2 时必填。格式如 https://example.com/video.mp4 示例值：https://media.w3.org/2010/05/sintel/trailer.mp4 |
||||||||||||||||||||||||||||||||
| AnnotationContext | 否 | AnnotationContext | 标注上下文信息 |
||||||||||||||||||||||||||||||||
| ProcessParams | 否 | ProcessParams | 标注处理参数，预留字段，当前无效 |
||||||||||||||||||||||||||||||||
| OutputInfo | 否 | OutputInfo | 结果输出信息 |
||||||||||||||||||||||||||||||||
| CallbackInfo | 否 | CallbackInfo | 回调信息，配置后当处理项状态从处理中变为其他状态时，服务端会向回调地址发送请求（退避重试三次，不保证回调一定送达，需保证目标地址接收服务有效），建议接收方做好幂等处理。回调请求格式如下：
请求体（application/json）
|
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务 ID 示例值：3uixltd7dni3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例1-对象存储源
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoAnnotationJob
<公共请求参数>
{
"InputType": 1,
"AnnotationType": 3,
"S3SourceInfo": {
"Bucket": "ai-annotation-test-input-1258344699",
"Endpoint": "cos-internal.ap-guangzhou.tencentcos.cn",
"Region": "ap-guangzhou",
"Key": "batch-test/1qLIfbvfNo_0003.mp4",
"Secret": {
"SecretId": "************************************",
"SecretKey": "********************************"
},
"IsCos": 1
},
"AnnotationContext": {
"TaskGoal": "把香蕉从盘子中夹出来",
"KeyObjects": [
"香蕉"
],
"AtomicVerbs": [
"拿取"
]
},
"OutputInfo": {
"Bucket": "ai-annotation-test-input-1258344699",
"Endpoint": "cos-internal.ap-guangzhou.tencentcos.cn",
"Region": "ap-guangzhou",
"Key": "annotation-result/1qLIfbvfNo_0003.json",
"Secret": {
"SecretId": "************************************",
"SecretKey": "********************************"
}
},
"CallbackInfo": {
"Url": "https://callback.example.com/annotation",
"Secret": "test-callback-secret-0f1e2d3c"
}
}输出示例
{
"Response": {
"JobId": "3uixltd7dni3",
"RequestId": "15df6e34-08b8-42c4-ab24-5b8dbac82a07"
}
}示例2 调用示例2-HTTP源
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoAnnotationJob
<公共请求参数>
{
"InputType": 2,
"AnnotationType": 3,
"HttpUrl": "https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/360/Big_Buck_Bunny_360_10s_1MB.mp4"
}输出示例
{
"Response": {
"JobId": "3uimnz9razwb",
"RequestId": "b38bba35-d582-45de-a7ea-e0749145839e"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.StorageCheckFailed | 存储连通性测试失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InvalidHttpUrl | 视频 URL 不可达或非法。 |
| InvalidParameterValue.InvalidRegion | 存储区域与桶实际地域不匹配。 |
| InvalidParameterValue.StorageUnreachable | 存储服务地址不可达。 |
| InvalidParameterValue.UnsupportedVideoFormat | 输入文件不是支持的视频格式。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied.AnnotationTypeNotEnabled | 标注模式未开放。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.StorageAuthFailed | 存储密钥无效或无权限。 |
