You need to enable JavaScript to run this app.
文档中心
图像生成大模型

图像生成大模型

复制全文
下载 pdf
通用图像分割
同步转异步接口使用说明
复制全文
下载 pdf
同步转异步接口使用说明
介绍​
当前商品下的部分能力已支持通过同步转异步接口进行异步调用,整个调用流程分为两个步骤:1. 使用CVSync2AsyncSubmitTask接口提交任务;2. 使用CVSync2AsyncGetResult接口查询任务结果。​
如有异步调用的需求,可参考本文档中提交任务与查询任务两个章节的示例进行调用。​
能力列表​
本商品下的部分能力已支持同步转异步接口调用,见下方列表​
​
序号​
能力接口文档​
1​
2​
3​
......​
​
提交任务​
提交任务请求参数​
Header参数​
完整公共参数列表见 公共参数​
本服务Region为cn-north-1; Service为cv​
Query参数​
拼接到url后的参数,示例:https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31​
​
参数​
可选/必选​
类型​
说明​
Action​
必选​
String​
接口名,固定值:​
CVSync2AsyncSubmitTask​
Version​
必选​
String​
版本号,固定值:2022-08-31​
​
请求示例​
请在能力列表中找到对应能力的接口文档,参考接口文档进行传参。下方示例为参考主体分割进行传参。​
注:在提交任务时无需传入logo_info 参数。​
​
{​
"req_key": "saliency_seg",​
"image_urls": [​
"https://xxx"​
],​
"only_mask": 3, //建议值​
"refine_mask": 0,​
"rgb": [ //建议值​
-1,​
-1,​
-1​
]​
}​
​
提交任务返回参数​
通用返回参数​
业务输出参数​
重点关注data 字段,其他字段为公共返回​
​
字段​
类型​
说明​
task_id​
String​
任务ID,用于查询结果 (task_id有效期为24小时)​
​
返回示例​
​
{​
"code": 10000, //状态码,判断状态,code!=10000的情况下,不会返回task_id​
"data": {​
"task_id": "7392616336519610409" //任务ID,查询接口使用​
},​
"message": "Success",​
"request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息​
"time_elapsed": "104.852309ms" //链路耗时​
}​
​
查询任务​
查询任务请求参数​
Header参数​
完整公共参数列表见 公共参数​
本服务Region为cn-north-1; Service为cv​
Query参数​
拼接到url后的参数,示例:https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31​
​
参数​
可选/必选​
类型​
说明​
Action​
必选​
String​
接口名,固定值:​
CVSync2AsyncGetResult​
Version​
必选​
String​
版本号,固定值:2022-08-31​
​
Body参数​
业务请求参数,放到request.body中,MIME-Type为application/json​
​
参数​
可选/必选​
类型​
说明​
示例​
req_key​
必选​
String​
算法名称,请在能力列表中找到对应能力的接口文档,参考接口文档中的算法名称进行传参​
​
task_id​
必选​
String​
任务ID,此字段为提交任务接口中返回的task_id​
​
req_json​
可选​
JSON String​
json序列化后的字符串​
目前支持水印配置,可在返回结果中添加​
"{"logo_info":{"add_logo":true,"position":0,"language":0,"logo_text_content":"这里是明水印内容"}}"​
​
ReqJson(序列化后的结果再赋值给req_json)​
配置信息​
​
参数​
可选/必选​
类型​
说明​
​
logo_info​
可选​
LogoInfo​
水印信息​
​
return_url​
可选​
bool​
输出是否返回图片链接 (链接有效期为24小时)​
​
aigc_meta​
可选​
AIGCMeta​
隐式标识​
隐式标识验证方式:​
  1. 查看【png】或【mp4】格式,人工智能生成合成内容表示服务平台(后续预计增加jpg)​
  1. 查看【jpg】格式,使用app11 segment查看aigc元数据内容​
​
LogoInfo​
水印相关信息​
​
名称​
类型​
必选​
描述​
add_logo​
Boolean​
否​
是否添加水印。True为添加,False不添加。默认不添加​
position​
Int​
否​
水印的位置,取值如下:​
0-右下角​
1-左下角​
2-左上角​
3-右上角​
默认0​
language​
Int​
否​
水印的语言,取值如下:​
0-中文(AI生成)​
1-英文(Generated by AI)​
默认0​
opacity​
Float​
否​
水印的不透明度,取值范围0-1,1表示完全不透明,默认1​
logo_text_content​
String​
否​
明水印自定义内容​
​
AIGCMeta​
隐式标识,依据《人工智能生成合成内容标识办法》&《网络安全技术人工智能生成合成内容标识方法》​
​
名称​
类型​
可选/必选​
描述​
content_producer​
string​
可选​
内容生成服务ID​
producer_id​
string​
必选​
内容生成服务商给此图片数据的唯一ID​
content_propagator​
string​
可选​
内容传播服务商ID​
propagate_id​
string​
可选​
传播服务商给此图片数据的唯一ID​
​
请求示例​
下方示例中req_key参数为参考主体分割接口文档中的算法名称进行传参。​
​
{​
"req_key": "saliency_seg",​
"task_id": "7418049665255653414",​
"req_json": "{\"logo_info\":{\"add_logo\":false,\"position\":0,\"language\":0,\"opacity\":1,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true,\"aigc_meta\":{\"content_producer\":\"xxx\",\"producer_id\":\"xxx\",\"content_propagator\":\"xxx\",\"propagate_id\":\"xxx\"}}"​
}​
​
查询任务返回参数​
通用返回参数​
业务输出参数​
重点关注data 字段,其他字段为公共返回​
​
字段​
类型​
说明​
binary_data_base64​
Array of string​
返回图片的base64数组。​
image_urls​
Array of string​
返回图片的url数组​
response_data​
String​
算法返回的一些信息,可忽略,是json序列化字符串​
status​
String​
in_queue:任务已提交​
generating:任务已被消费,处理中​
done:处理完成,成功或者失败,可根据外层code&message进行判断​
not_found:任务未找到,可能原因是无此任务或任务已过期(12小时)​
​
返回示例​
​
{​
"code": 10000, //状态码,优先判断 code=10000, 然后再判断data.status,否则解析有可能会panic​
"data": {​
"algorithm_base_resp": {​
"status_code": 0,​
"status_message": "Success"​
},​
"bbox": [​
[​
1096,​
438,​
1857,​
1766​
]​
],​
"binary_data_base64": [​
""​
],​
"contours_point": [​
[​
[​
[​
2076,​
440​
],​
[​
2058,​
441​
] ​
]​
]​
],​
"ori_height": [​
2204​
],​
"ori_width": [​
3306​
],​
"seg_score": [​
0.005572378635406494​
],​
"shadow": [​
null​
],​
"shadow_pos": [​
null​
]​
},​
"message": "Success",​
"status": 10000, //无需关注,请忽略​
"request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息​
"time_elapsed": "508.312154ms" //链路耗时​
}​
​
返回报错示例:​
​
{​
"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" //链路耗时​
}​
​
错误码​
(1)通用错误码​
(2)业务错误码​
​
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​
输入文本NER、IP、Blocklist等拦截​
​
SDK使用说明​
请参考SDK使用说明​
HTTP方式接入说明​
请参考HTTP请求示例​
API_KEY方式接入说明​
最近更新时间:2026.09.21 15:27:44
这个页面对您有帮助吗?
有用
有用
无用
无用