文档中心

即梦AI

即梦AI-交互编辑inpainting

即梦AI-交互编辑inpainting-接口文档

接口简介

即梦「局部重绘」「消除笔」同款图像编辑功能：用户可通过涂抹、选区等方式建立重绘区域，将相应mask图及文本prompt传入模型，即可重新编辑生成图片。

本能力支持涂抹消除，和涂抹编辑场景，在消除的场景，输入prompt文本为删除即可；在涂抹编辑场景，可以用自然语言描述预期生成的内容，涉及文字内容的修改建议将修改后的文字放在“”双引号内，会提升准确率

接入说明

在智能视觉控制台，开通服务后调用

接口说明

限制条件

名称	内容
输入图要求	图片格式：仅支持JPEG、PNG格式，建议使用JPEG格式；图片文件大小：最大 4.7MB，图片分辨率：最大 4096 * 4096。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

提交任务

提交任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31

参数	类型	可选/必选	说明
Action	string	必选	接口名，取值：CVSync2AsyncSubmitTask
Version	string	必选	版本号，取值：2022-08-31

Header参数

注意

本服务固定值：Region为cn-north-1，Service为cv

主要用于鉴权，详见公共参数 - 签名参数 - 在Header中的场景部分

Body参数

注意

业务请求参数，放到request.body中，MIME-Type为application/json

名称	类型	必选	描述
req_key	string	必选	服务标识取固定值: jimeng_image2image_dream_inpaint
binary_data_base64	array of string	必选（二选一）	图片文件base64编码，需输入2张图片，图片尺寸需保持一致第一张为原图第二张为涂抹后的mask图。mask图为单通道灰度图，其中原图保持部分像素值为0（即黑色区域），待重绘部分像素值为255（即白色区域）
image_urls	array of string	必选（二选一）		图片文件URL，需输入2张图片，图片尺寸需保持一致第一张为原图第二张为涂抹后的mask图。mask图为单通道灰度图，其中原图保持部分像素值为0（即黑色区域），待重绘部分像素值为255（即白色区域）
prompt	string	必选	用于编辑图像的提示词，支持中英文，建议长度 <= 120字符，支持涂抹消除和涂抹编辑场景在消除的场景，输入prompt文本为删除即可在涂抹编辑场景，可以用自然语言描述预期生成的内容，涉及文字内容的修改建议将修改后的文字放在“”双引号内，会提升准确率
seed	int	可选	随机种子，作为确定扩散初始状态的基础（-1表示随机）。若随机种子为相同正整数且其他参数均一致，则生成内容极大概率效果一致默认值：101

提交任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析)

字段	类型	说明
task_id	string	任务ID，用于查询结果

提交任务请求&返回完整示例

请求示例：

返回示例：

查询任务

查询任务请求参数

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31

参数	类型	可选/必选	说明
Action	string	必选	接口名，固定值：CVSync2AsyncGetResult
Version	string	必选	版本号，固定值：2022-08-31

Header参数

注意

本服务固定值：Region为cn-north-1，Service为cv

主要用于鉴权，详见公共参数 - 签名参数 - 在Header中的场景部分

Body参数

注意

业务请求参数，放到request.body中，MIME-Type为application/json

参数	类型	可选/必选	说明
req_key	string	必选	服务标识取固定值: jimeng_image2image_dream_inpaint
task_id	string	必选	任务ID，此字段的取值为提交任务接口的返回
req_json	JSON string	可选	json序列化后的字符串目前支持水印配置和是否以图片链接形式返回，可在返回结果中添加示例："{\"return_url\":true,\"logo_info\":{\"add_logo\":false,\"position\":0,\"language\":0,\"opacity\":1,\"logo_text_content\":\"这里是明水印内容\"},\"aigc_meta\":{\"content_producer\":\"xxx\",\"producer_id\":\"xxx\",\"logo_text_content\":\"xxx\",\"logo_text_content\":\"xxx\"}}"

ReqJson(序列化后的结果再赋值给req_json)

配置信息

参数	类型	可选/必选	说明
return_url	bool	可选	输出是否返回图片链接（链接有效期为24小时）默认 false
logo_info	LogoInfo	可选	水印信息
aigc_meta	AIGCMeta	可选	隐式标识隐式标识验证方式：查看【png】或【mp4】格式，人工智能生成合成内容表示服务平台（后续预计增加jpg） https://www.gcmark.com/web/index.html#/mark/check/image 查看【jpg】格式，使用app11 segment查看aigc元数据内容如 https://cyber.meme.tips/jpdump/#

LogoInfo

水印相关信息

名称	类型	可选/必选	描述
add_logo	bool	可选	是否添加水印。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

查询任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务返回参数

说明

重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析)

参数名	参数说明	参数示例
binary_data_base64	array of string	返回图片的base64数组。
image_urls	array of string	返回图片的url数组，输出图片格式为jpeg格式（有效期是24h）
status	string	任务执行状态 in_queue：任务已提交 generating：任务已被消费，处理中 done：处理完成，成功或者失败，可根据外层code&message进行判断 not_found：任务未找到，可能原因是无此任务或任务已过期(12小时) expired：任务已过期，请尝试重新提交任务请求

查询任务请求&返回完整示例

请求示例：

返回示例：

返回报错示例：

错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

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	输入文本含敏感词、版权词等审核不通过	不需要
400	50518	Pre Img Risk Not Pass: Copyright	输入版权图前审核未通过	不需要
400	50519	Post Img Risk Not Pass: Copyright	输出版权图后审核未通过	可重试
400	50520	Risk Internal Error	审核服务异常	不需要
400	50521	Antidirt Internal Error	版权词服务异常	不需要
400	50522	Image Copyright Internal Error	版权图服务异常	不需要
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使用说明

HTTP方式接入说明

请参考HTTP请求示例

HTTP方式接入说明

请参考HTTP请求示例

API_KEY方式接入说明

请参考API_KEY请求示例

Python-提交任务

Python-查询任务

Go-提交任务

Go-查询任务

Java-提交任务

Java-查询任务

PHP-提交任务

PHP-查询任务

发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！

request

# coding:utf-8
from __future__ import print_function

import json
import os

from volcengine import visual
from volcengine.visual.VisualService import VisualService

if __name__ == '__main__':
    visual_service = VisualService()

    # call below method if you don't set ak and sk in $HOME/.volc/config
    visual_service.set_ak(os.getenv("AK"))
    visual_service.set_sk(os.getenv("SK"))

    form = {
        "req_key": "jimeng_image2image_dream_inpaint",
        "image_urls": [
            "https://cv-test-project.tos-cn-beijing.volces.com/doc_image/inpainting_image.png",
            "https://cv-test-project.tos-cn-beijing.volces.com/doc_image/inpainting_mask.png",
        ],
        "prompt": "小女孩跪着祈福，一个香炉上点着香",
    }
    resp = visual_service.cv_sync2async_submit_task(form)
    print(json.dumps(resp, ensure_ascii=False))

response

{
    "code": 10000, //状态码，判断状态，code!=10000的情况下，不会返回task_id
    "data": {
        "task_id": "7392616336519610409" //任务ID，查询接口使用
    },
    "message": "Success",
    "request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息
    "time_elapsed": "104.852309ms" //链路耗时
}

最近更新时间：2026.09.21 15:47:54

这个页面对您有帮助吗？

有用

无用