1. 接口描述
接口请求域名: ims.tencentcloudapi.com 。
接口使用说明
本接口适用于"标准内容安全"、"AI 生成识别"、"图文审核 Agent"服务,对接前请先参考快速入门,配置好业务基础信息。
- 标准内容安全-快速入门:https://cloud.tencent.com/document/product/1124/135196
- AI 生成识别-快速入门:https://cloud.tencent.com/document/product/1124/135204
- 图文审核 Agent:接口兼容,具体调用方式请联系商务获取
接口功能说明
- 标准内容安全:对图片内容进行检测,识别其中不安全、不适宜的信息
- AI 生成识别:识别图像中使用大模型工具的生成痕迹,判断图片是否存在 AI 生成风险
- 图文审核 Agent:基于大模型能力,按客户自定义的业务规则审核图片及文本内容
接口调用说明
支持格式
- 静态图:BMP、ICO、JPEG、JNG、PNG、TIFF、RAW、SVG、GIF、WEBP、HEIC、HEIF、AVIF
- 动态图:GIF、WEBP、HEIC(每 5 帧均匀采样 1 次,默认最多抽取 5 帧)
文件大小
- 尺寸:图片宽高需大于 20 px 且小于 10000 px,宽高比小于 90:1
- 分辨率:建议大于 256×256,以保证识别效果
- 大小:文件最小 16 字节;通过 Base64 编码输入需小于 10 MB;通过 FileURL 访问的源图需小于 30 MB
链接与下载
- 并发限制:每次仅能传输一条 URL,支持多并发请求,默认并发 20 QPS,超出返回
RequestLimitExceeded - 链接要求:仅支持 HTTP 和 HTTPS 协议,且必须为直接指向图片资源的链接,不支持异步回源;受网络安全策略影响,带 HTTP 302 重定向的链接可能下载失败,因重定向或其他原因导致的下载失败,返回
ResourceUnavailable.ImageDownloadError - 下载超时:下载超时时间为 15 秒,失败后重试 1 次(间隔 3 秒),共 18 秒下载时间;重试仍失败则返回
ImageDownloadError - 存储建议:为保障被检测图片的访问稳定性和可靠性,建议使用腾讯云 COS 存储或 CDN 缓存
- 并发限制:每次仅能传输一条 URL,支持多并发请求,默认并发 20 QPS,超出返回
接口回调格式
图片异步检测接口的回调格式与图片同步检测接口输出参数一致,详见 图片同步检测接口输出参数。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateImageModerationAsyncTask。 |
| Version | 是 | String | 公共参数,本接口取值:2020-12-29。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
| CallbackUrl | 是 | String | 接收审核信息回调地址,审核过程中产生的所有结果发送至此地址。 示例值:https://callback.example.com/tencnet/callback |
| BizType | 否 | String | 接口使用的识别策略编号,该策略编号在控制台上获取,获取方式请参考快速入门:
示例值:TencentCloudDefault |
| DataId | 否 | String | 该字段表示您为待检测图片分配的数据 ID,作用是方便您对数据进行标识和管理。 示例值:a6127dd-c2a0-43e7-a3da-d27022d39ba7 |
| FileContent | 否 | String | 待检测图片的 Base64 编码, 该字段与FileUrl必须选择输入其中一个。 示例值:待检测图片的 Base64 编码,该字段与下面 FileUrl 二选一,必填其一。 示例值:aHR0cDovL2lubmVycG9ybnNjcmVlbnNob3QtMTI1MjgxMzg1MC5jb3MuYXAtZ3Vh |
| FileUrl | 否 | String | 待检测图片的访问链接,该字段与FileContent必须选择输入其中一个。 示例值:https://cmsdemo-001.cos.ap-guangzhou.myqcloud.com/imagedemo.jpg |
| Interval | 否 | Integer | 用于 GIF 检测,表示截帧频率(每隔多少帧抽取一帧进行检测)。 示例值:1 |
| MaxFrames | 否 | Integer | 用于 GIF 检测,指定最大截帧数量,上限为 5 帧(暂不支持上调至更高值)。 示例值:1 |
| User | 否 | User | 该字段标识用户信息,传入后可增强甄别有违规风险的发布者账号。 |
| Device | 否 | Device | 该字段标识设备信息,传入后可增强甄别有违规风险的发布者设备。 |
| Type | 否 | String | 服务类型,可为空,默认为 IMAGE。 枚举值:
示例值:IMAGE |
| FileUrlList.N | 否 | Array of String | 审核 Agent 专用:待审核图片的访问链接 ,一次请求最多支持传入 4 张。 示例值:["https://xxxxxxxxx1.jpg","https://xxxxxxxxx2.jpg"] |
| TextContent | 否 | String | 审核 Agent 专用:待审文本内容,需使用 UTF-8 编码并以 Base64 格式传入,字数上限 5000 字。 示例值:5L2g55qE5Lil6LCo6K6p5L2g5Y+R546w77yM5Lqn5ZOB57uP55CG5Y+r5YmR6Z2S |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataId | String | 该字段用于返回检测对象对应请求参数中的DataId。 示例值:a61237dd-c2a0-43e7-a3da-d27022d39ba7 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建异步审核任务示例
创建异步审核任务示例
输入示例
POST / HTTP/1.1
Host: ims.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageModerationAsyncTask
<公共请求参数>
{
"BizType": "TencentCloudDefault",
"FileUrl": "https://test.jpg",
"DataId": "a61237dd-c2a0-43e7-a3da-d27022d39ba7",
"CallbackUrl": "https://callback.example.com/tencnet/callback",
"Type": "IMAGE"
}
输出示例
{
"Response": {
"RequestId": "193101e1-e9b6-4a9b-b29e-6e37db58beef",
"DataId": "a61237dd-c2a0-43e7-a3da-d27022d39ba7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ImageSizeTooSmall | 图片分辨率过低。 |
| InvalidParameter.InvalidImageContent | 图片内容错误。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.EmptyImageContent | 图片内容参数为空。 |
| InvalidParameterValue.ImageSizeTooSmall | 图片分辨率太低。 |
| InvalidParameterValue.InvalidCallbackUrl | 回调地址错误。 |
| InvalidParameterValue.InvalidContent | FileContent和FileUrl为空或base64编码错误。 |
| InvalidParameterValue.InvalidDataId | DataId格式错误。 |
| InvalidParameterValue.InvalidFileContentSize | 图片文件内容大小异常。 |
| InvalidParameterValue.InvalidImageContent | 图片内容错误。 |
| InvalidParameterValue.InvalidParameter | 参数值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.ImageDownloadError | 图片文件下载失败。 |
| ResourceUnavailable.InQueueError | 入队列失败 |
| ResourceUnavailable.InvalidImageContent | 图片资源错误。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.Unauthorized | 未开通权限/无有效套餐包/账号已欠费。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |