中文版
快速试用控制台

场景图生成任务提交API调用说明

场景图生成任务提交

POST /ai/image/background/generation/scenario

基于传入的场景ID，自动从图片中提取商品主体，生成各种不同场景风格的高质量产品图像。背景图生成是异步生成方式。该API是提交生成任务；如需获取生成结果，请调用结果查询接口。

请求参数

参数类型必填参数描述及示例值

requestParams

Object[]

是

请求参数

imageFileUrl

String

否

商品图片URL。

与imageBase64不能同时为空。如果同时存在imageUrl和iImageBase64，优先取 Base64。

图片尺寸应该大于512*512像素，小于3000*3000像素。

imgBase64

String

否

商品图片的Base64编码。

跟imageUrl不能同时为空。如果同时存在imageUrl和imageBase64，优先取 Base64。

图片尺寸应该大于512*512像素，小于3000*3000像素。

modelNum

String

否

需要生成的场景编号。场景编号的查询请使用“场景图背景模板推荐与查询”接口。

needLayout

Boolean

否

是否需要对商品进行重新布局。

取值范围：

true：对商品位置进行重新布局

false：使用传入图片的商品位置，不进行重新布局。

示例值: true

productTitle

String

否

商品标题。

如果不需要自动布局，则无需传入。

仅支持中文或英文的商品标题。

width

Number

是

期望生成的图片宽度。

单位：像素。

目前仅支持生成1：1（宽800*高800）和3：4（宽750*高1000）的尺寸。

示例值：800

height

Number

是

期望生成的图片高度。

单位：像素。

目前仅支持生成1：1（宽800高800）和3：4（宽750高1000）的尺寸。

示例值：800

imageNum

Number

是

期望生成的图片数量。

单次任务最少生成2张，最多生成10张。如果不设置，默认生成4张。

取值范围：2-10

示例值：4

请求示例

  • 以下是对应图片输入限制：

  • 图像格式：JPEG、JPG、PNG、BMP、WEBP。

  • 图像大小：不超过 4 MB。

  • 图像分辨率：输入图片尺寸大于 512×512 像素，小于 3000×3000 像素。

IopClient client = new IopClient(url, appkey, appSecret);
IopRequest request = new IopRequest();
request.setApiName("/ai/image/background/generation/scenario");
request.addApiParameter("requestParams", "[{\"productTitle\":\"hello\",\"imgBase64\":\"\u56FE\u7247base64\u683C\u5F0F\",\"needLayout\":\"true\",\"modelNum\":\"mod001\",\"width\":\"800\",\"imageNum\":\"2\",\"imageFileUrl\":\"https://ae01.alicdn.com/kf/S2d0d88e656384da894b7cfe9c59b0c0du.jpg\",\"height\":\"800\"}]");
IopResponse response = client.execute(request);
System.out.println(response.getBody());
Thread.sleep(10);

响应参数

参数类型描述

resCode

Number

返回的结果码，其中200代表成功，详细错误码请参考错误码列表。

requestId

String

唯一的请求ID。用于排查问题。

success

Boolean

返回的请求状态，代表请求是否成功。

resMessage

String

返回的请求信息。

data

Object

返回的json结果数据。

result

Object

返回的结果数据。

taskId

String

唯一的任务ID。用于后续的请求结果查询。

响应示例

{
  "data": {
    "result": {
      "taskId": "713f0cb3-f22f-490b-b3b7-3684f73bf2d6"
    }
  },
  "requestId": "21410cde17193034854038265ecd92",
  "success": true,
  "resCode": 200,
  "resMessage": "success",
  "code": "0",
  "request_id": "212a664f17193034854051990",
  "_trace_id_": "21410cde17193034854038265ecd92"
}

错误码

错误码错误信息描述

500

system error

服务器内部错误

501

rate limit exceed

当前接口已达到限流上限,请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们增加当前限制值。

700

invalid input

输入参数的格式不符合要求，resMessage 将返回详细的不符合要求的字段。

801

model failed

内部调用异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们进行故障排除。

1000

content has sensitive data, please try other input

内容包含敏感数据，无法处理，请尝试其他输入。

1001

content control failed, please retry

风控服务运行异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们。

1002

content risk filter failed, please contact us

风控服务运行异常，请搜索Aidge产品咨询&服务群钉钉群号：105455001046，入群联系我们。

Previous场景图背景推荐与查询 API 调用说明Next场景图生成结果查询API参考

Last updated