## 接口简介用于识别图片中是否包含人、类人、拟人等主体。 ## 限制条件 |名称 |内容 | |---|---| |图片要求 |1. 图片格式：JPG(JPEG), PNG, JFIF 等常见格式, 建议使用JPG格式|\ | |2. 图片要求：小于5 MB，小于4096\*4096。|\ | |3. 输入图：建议做前置检测，输入图中为单人、人脸占比大、正面效果较好，其他类型图片效果不佳 | ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) | |请求方式 |POST | |Content\-Type |application/json | ## 提交任务 ### **提交任务请求参数** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com?Action=CVSubmitTask&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVSubmitTask&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，取值：CVSubmitTask | |Version |必选 |String |版本号，取值：2022\-08\-31 | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |名称 |类型 |必选 |描述 |备注 | |---|---|---|---|---| |req_key |string |是 |服务标识| |\ | | | |取固定值: **realman_avatar_picture_create_role_omni** | | |image_url |string |是 |人像图片URL链接 | | ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |task_id |string |任务ID，用于查询结果 | ### 提交任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "realman_avatar_picture_create_role_omni", "image_url": "https://xxxxx.jpg" } ``` **返回示例：** ```JSON { "code": 10000, //状态码，判断状态，code!=10000的情况下，不会返回task_id "data": { "task_id": "7392616336519610409" //任务ID，查询接口使用 }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息 "time_elapsed": "104.852309ms" //链路耗时 } ``` ## 查询任务 ### **查询任务请求参数** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/)[?Action=CVGetResult&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVGetResult&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，固定值：CVGetResult | |Version |必选 |String |版本号，固定值：**2022\-08\-31** | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |可选/必选 |类型 |说明 |示例 | |---|---|---|---|---| |req_key |必选 |String |服务标识| |\ | | | |取固定值: **realman_avatar_picture_create_role_omni** | | |task_id |必选 |String |任务ID，此字段的取值为**提交任务接口**的返回 | | ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |参数名 |参数说明 |参数示例 | |---|---|---| |resp_data |图片识别结果|"{\"progress\": 100, \"received_at\": 1748339398, \"processed_at\": 1748339398, \"finished_at\": 1748339400, \"gpu_type\": \"unknown\", \"binary_data_url_list\": [], \"binary_data_info_list\": [], \"code\": 0, \"msg\": \"success\", \"resource_id\": null, ** ==\"status\": 1==**, \"message\": null, \"refuse_code\": [], \"face_position\": null, \"body_position\": null, \"role_type\": null, \"face_position_norm\": null}" |\ | |resp_data为序列化后的JSON字符串，其中的**status**参数为识别结果，取值为：| |\ | || |\ | |* 0：不包含人、类人、拟人等主体| |\ | |* 1：包含人、类人、拟人等主体 | | |status |任务执行状态| |\ | || |\ | |* in_queue：任务已提交| |\ | |* generating：任务已被消费，处理中| |\ | |* done：处理完成，成功或者失败，可根据外层code&message进行判断| |\ | |* not_found：任务未找到，可能原因是无此任务或任务已过期(12小时)| |\ | |* expired：任务已过期，请尝试重新提交任务请求 | | ### 查询任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "realman_avatar_picture_create_role_omni", "task_id": "<任务提交接口返回task_id>" } ``` **返回示例：** ```JSON { "code": 10000, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": { "binary_data_base64": [], "image_urls": null, "resp_data": "{\"progress\": 100, \"received_at\": 1748339398, \"processed_at\": 1748339398, \"finished_at\": 1748339400, \"gpu_type\": \"unknown\", \"binary_data_url_list\": [], \"binary_data_info_list\": [], \"code\": 0, \"msg\": \"success\", \"resource_id\": null, \"status\": 1, \"message\": null, \"refuse_code\": [], \"face_position\": null, \"body_position\": null, \"role_type\": null, \"face_position_norm\": null}", "status": "done" //任务状态 }, "message": "Success", "status": 10000, //无需关注，请忽略 "request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息 "time_elapsed": "508.312154ms" //链路耗时 } ``` **返回报错示例：** ```JSON { "code": 50413, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": null, //code!=10000的情况下，该字段返回为null "message": "Post Text Risk Not Pass", //错误信息 "request_id": "202511281418218670D408837A9B0EB58F", //排查错误的关键信息 "status": 50413, //无需关注，请忽略 "time_elapsed": "36.799829ms" //链路耗时 } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务错误码** |HttpCode |错误码 |错误消息 |描述 |是否需要重试 | |---|---|---|---|---| |200 |10000 |无 |请求成功 |不需要 | |400 |50411 |Pre Img Risk Not Pass |输入图片前审核未通过 |不需要 | |400 |50511 |Post Img Risk Not Pass |输出图片后审核未通过 |可重试 | |400 |50412 |Text Risk Not Pass |输入文本前审核未通过 |不需要 | |400 |50512 |Post Text Risk Not Pass |输出文本后审核未通过 |不需要 | |400 |50413 |Post Text Risk Not Pass |输入文本含敏感词、版权词等审核不通过 |不需要 | |429 |50429 |Request Has Reached API Limit, Please Try Later |QPS超限 |可重试 | |429 |50430 |Request Has Reached API Concurrent Limit, Please Try Later |并发超限 |可重试 | |500 |50500 |Internal Error |内部错误 |可重试 | |500 |50501 |Internal RPC Error |内部算法错误 |可重试 | ## 接入说明 ### SDK使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

图像生成大模型