创建 AIGC 异步任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建 AIGC 异步任务

最近更新时间：2023.09.05 19:19:00首次发布时间：2023.09.05 19:19:00

本接口支持根据输入的原图以及辅助描述文本内容（当前仅支持英文），智能生成与之相符的结果图。

说明

当前固定可输出 4 张图片长宽比为 1:1 的结果图。

注意事项

请求频率：单用户请求频率限制为 2 次/秒。
使用限制：请在 veImageX 控制台提前开通 AIGC 组件。
计费说明：使用 AIGC 将生成一定的使用费用，更多内容请参考控制台组件上计费详情。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetAiGenerateImage&Version=2018-08-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头数据

Query

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

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

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAiGenerateImage`	接口名称。当前 API 的名称为 `GetAiGenerateImage`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`7h**21`	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

7h**21

服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
Url	String	是	`http://test.imagex.com/tos-cn-i-rw**qr/864c.png~tplv-rw*qr-6.image`	输入原图 URL。智能算法将根据您输入原图并结合文本描述智能生成相关图像。
NeedSeg	Boolean	否	`false`	是否使用分割处理图片，取值如下所示： `true`：分隔处理 `false`：（默认）不分割处理，从输入图像读取 alpha 通道作为 mask。说明图像 mask 指在图像上添加一个遮罩层，使图像的某些部分被隐藏或不可见。
PositivePrompt	String	否	`best quality, front view, standing on a circular platform, surrounded by flowers and leaves, sunlight from the right, product photography`	正向提示词，提示词和 Scene 两者不可同时为空。两者均存在时，以 Scene 为准。当前仅支持英文，最多不超过 300 个字母。说明建议文本内容尽可能详细准确，详细的文本描述内容有助于获得更佳的图片生成效果。
NegativePrompt	String	否	`op view, empty background, extra connection, wheel, stand, lowres, ugly, bad anatomy, bad hands, cropped, worst quality`	负向提示词，提示词和 Scene 两者不可同时为空。两者均存在时，以 Scene 为准。当前仅支持英文，最多不超过 300 个字母。
ProductRatio	Float	否	`0.2`	商品 mask 长宽与 output_size 比值的上限。取值范围为 (0,1]。取值越小，则产品图和生成的背景图比例就越小。
OutputSize	Integer	是	`1000`	指定结果图长和宽的值，单位为 px。取值范围为[512,2048]。说明输出结果图的规格为 1:1 方图。
Callback	String	否	`https://a.callback.com`	任务回调地址，需为公网可访问，使用 POST 请求。具体回调参数请参考回调内容。
Scene	String	否	`flower and leaves`	根据所选场景生成结果图，场景支持以下选项： `indoor wooden table`：室内木桌场景 `flower and leaves`：鲜花绿植场景 `white marble table`：白色大理石场景 `outdoor snow scene`：室外雪景场景

返回参数

参数	类型	示例值	描述
TaskId	String	`928fh***204`	任务 ID

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetAiGenerateImage&Version=2018-08-01&ServiceId=7h%2A%2A21
{
    "URL": "http://test.imagex.com/tos-cn-i-rw****qr/86****4c.png~tplv-rw***qr-6.image",
    "OutputSize": 1000
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetAiGenerateImage",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
      "TaskId": "928fh***204"
  }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

回调内容

参数	说明
Status	任务状态，取值如下所示： Success：处理成功 Running：进行中 Failed：处理失败
TaskId	任务 ID
Uris	处理图 URI

参数

说明

Status

任务状态，取值如下所示：

Success：处理成功
Running：进行中
Failed：处理失败

TaskId

任务 ID

Uris

处理图 URI