图片单次审核--veImageX-火山引擎

文档中心

立即注册

veImageX

智能审核

图片单次审核

本接口用于对单张图片进行内容审核，支持同步和异步两种审核方式，适用于内容安全审核、违规图片过滤等场景。

使用说明

同步审核（Async 取值为 0）时，接口会直接返回审核结果。
异步审核（Async 取值为 1）时，审核结果会发送至您的回调地址（CallbackUrl）。

注意事项

计费说明：智能审核属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：使用组件前，请先确认智能审核使用限制。
请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=SingleImageAudit&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述

Action String 是 SingleImageAudit 接口名称。当前 API 的名称为 SingleImageAudit。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`SingleImageAudit`	接口名称。当前 API 的名称为 `SingleImageAudit`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`ln***tb`	用于存储结果图和计量计费的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

ln***tb

用于存储结果图和计量计费的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	示例值	描述
AuditAbility	Integer	是	`1`	审核能力类型，用于指定审核任务所使用的审核模型。目前仅支持取值 `1`，即智能审核能力。
AuditDimensions	Array of String	是	`["porn","sexy"]`	图像风险审核的具体维度。取值如下： `porn` ：涉黄，主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别 `sensitive1` ：涉敏1，具体指涉及暴恐风险 `sensitive2`：涉敏2，具体值涉及政治内容风险 `forbidden`：违禁，主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别 `uncomfortable`：引人不适，主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别 `qrcode`：二维码，主要适用于识别常见二维码（QQ、微信、其他二维码等） `badpicture`：不良画面，主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别 `sexy`：性感低俗，主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别 `age`：年龄，主要适用于图中人物对应的年龄段识别 `underage`：未成年相关，主要适用于儿童色情、儿童邪典等风险识别 `quality`：图片质量，主要适用于图片模糊、纯色边框、纯色屏等风险识别说明您可将 `AuditDimensions` 与 `AuditTextDimensions` 搭配使用，实现图像和文字内容的综合审核。
EnableLargeImageDetect	Boolean	否	`false`	是否开启大图审核功能。默认值为 `false`。支持的取值如下所示。 `true`：开启大图审核，系统会对 5MB~32MB 的图片进行压缩后再审核； `false`：不开启大图审核。说明未开启时若图片大小 ≥ 5 MB，可能导致系统超时报错；已开启时若图片大小 ≥ 32 MB，可能导致系统超时报错；开启后将对压缩能力按照基础图片处理进行计费（每月有 20TB 免费额度）。
ImageUri	String	是	`http://example.com/image.jpg`	图片的公网可访问 URL，用于指定需要审核的图片资源地址。
DataId	String	否	`92bodw28122j19***018h3i1928g`	自定义标识，用于区分待审核图片 `ImageUri` 的唯一标识，建议根据实际业务需求设置。
AuditTextDimensions	Array of String	否	`["ad","charillegal"]`	文字审核的具体维度。默认不审核任何维度。取值如下： `ad`：识别图像上的广告文字。 `defraud`：识别图像上的诈骗文字。 `charillegal`：识别图像上的涉黄、涉敏、违禁等违规文字。说明您可将 `AuditTextDimensions` 与 `AuditDimensions` 搭配使用，实现图像和文字内容的综合审核。
Async	Integer	否	`0`	是否异步进行审核，默认值为 `0`。支持的取值如下所示。 `0`：同步返回结果； `1`：异步进行审核。
CallbackUrl	String	否	`https://www.example.com/callback`	审核结果（Detail 版本）以回调形式发送至您的回调地址，仅当 `Async` 取值为 `1` 时生效。支持以 `http://` 或者 `https://` 开头的地址。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ImageUri	String	`http://example.com/image.jpg`	图片的公网可访问 URL，用于指定需要审核的图片资源地址。
DataId	String	`92bodw28122j19***018h3i1928g`	建议您根据实际业务情况，将该参数作为可区分审核图片 `ImageUri` 的自定义标识。
Advice	String	`block`	图片审核的建议结果，表示系统对图片内容的审核意见。支持的取值如下所示。 `block`：审核不通过； `review`：需要人工复核。
Label	Array of String	`["porn"]`	图片内容的一级审核标签，用于标识图片内容的主要分类。
SubLabel	Array of String	`["30302"]`	图片内容的二级审核标签，用于进一步细化 `Label` 的分类，提供更具体的审核结果。
ImageType	String	`normal`	审核结果，取值如下所示： `problem`：问题图片 `normal`：正常图片

请求示例

POST https://imagex.volcengineapi.com/?Action=SingleImageAudit&Version=2023-05-01&ServiceId=ln***tb
{
    "AuditAbility": 1,
    "AuditDimensions": [
        "porn",
        "sexy"
    ],
    "EnableLargeImageDetect": true,
    "ImageUri": "http://example.com/image.jpg",
    "DataId": "92bodw28122j19***018h3i1928g",
    "AuditTextDimensions": [
        "ad",
        "charillegal"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "SingleImageAudit",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ImageUri": "http://example.com/image.jpg",
        "DataId": "92bodw28122j19***018h3i1928g",
        "Advice": "block",
        "Label": [
            "porn"
        ],
        "SubLabel": [
            "30302"
        ],
        "ImageType": "normal"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

最近更新时间：2026.01.26 15:49:55

这个页面对您有帮助吗？

有用

无用

veImageX

使用说明 #

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #