创建文生图异步任务--veImageX-火山引擎

文档中心

立即注册

导航

创建文生图异步任务

最近更新时间：2024.11.15 13:53:28首次发布时间：2024.11.08 11:15:13

该接口支持调用豆包大模型中的智能生图 API 能力，并根据豆包模型请求信息生成相应图片。同时您可指定 veImageX 的图片处理模板，对文生图进行定制化的图片处理。

使用说明

本段主要介绍如何获取调用时的参数信息，以及获取后在本接口的具体传参位置。

获取 veImageX 配置信息：服务 IDServiceId、域名Domain、模版配置Template。
选择一个本次要使用的豆包的文生图模型。
根据所选模型对应的接口文档，完成 ModelAction、ModelVersion 和 ReqJson 这个三个参数的填写。
根据实际业务需要，指定输出图的文件名Outputs。

注意事项

前提条件：请确保已完成准备操作。
请求频率：请遵循豆包大模型中的智能绘图的 QPS 限制。
超时时间：超时时间为 30 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateCVImageGenerateTask&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

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

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

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateCVImageGenerateTask`	接口名称。当前 API 的名称为 `CreateCVImageGenerateTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`serviceid`	指定存储结果图并计量计费的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

serviceid

指定存储结果图并计量计费的服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
Domain	String	是	`domain.test.com`	服务下绑定的域名，域名状态需正常可用。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取绑定的域名信息。您也可以通过 OpenAPI 的方式获取域名，具体请参考获取服务下全部域名。
Template	String	是	`tplv-serviceid-test.image`	服务下创建的图片处理模板配置（不带~），指定后，将按照模板中的处理配置对生成的原始图片进行图片处理。您可在 veImageX 控制台的处理配置页面，参考新建模板配置模板并获取模版信息，例如 `tplv-f0****5k-test.image`。
ModelAction	String	是	`CVSync2AsyncSubmitTask`	文生图系列模型的接口 Action 名称。例如，使用通用 2.0S-文生图异步，则 `ModelAction` 需要取值为 `CVSync2AsyncSubmitTask`。
ModelVersion	String	是	`2022-08-31`	文生图系列模型的接口 Version 名称。例如，使用通用 2.0S-文生图异步，则 `ModelVersion` 需要取值为 `2022-08-31`。
ReqJson	JSON Map	是	详见描述内取值示例	文生图系列模型的接口的请求 JSON 字符串。例如，使用通用 2.0S-文生图异步的必填参数，则 `ReqJson` 传值示例如下所示： `{ "req_key":"high_aes_general_v20", "prompt":"千军万马", "model_version":"general_v2.0" }`
Overwrite	Boolean	否	`true`	是否覆盖服务下同名文件，取值如下所示： `false`：（默认）不覆盖 `true`：覆盖说明请确保您已开启重名覆盖上传功能，否则，此处配置无效。
Outputs	Array of String	是	`["demo1.png"]`	指定输出图片的文件名，输入限制如下所示：不支持空格。不支持以/开头或结尾，不支持/连续出现，最大长度限制为 180 个字节。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述

TaskId String 7418048504813240370 任务 ID，用于查询结果。

参数	类型	示例值	描述
TaskId	String	`7418048504813240370`	任务 ID，用于查询结果。
RespJson	JSON Map	详见描述内取值示例	根据指定的文生图模型接口信息，接收的该接口响应的 JSON 数据。例如： `{ "code": 10000, "data": { "task_id": "7418048504813240370" }, "message": "Success", "request_id": "2024092411365866C579D2A96A35DA62A9", "status": 10000, "time_elapsed": "23.099216ms" }`

RespJson

JSON Map

详见描述内取值示例

根据指定的文生图模型接口信息，接收的该接口响应的 JSON 数据。例如：

{
    "code": 10000,
    "data": {
        "task_id": "7418048504813240370"
    },
    "message": "Success",
    "request_id": "2024092411365866C579D2A96A35DA62A9",
    "status": 10000,
    "time_elapsed": "23.099216ms"
}

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateCVImageGenerateTask&Version=2023-05-01&ServiceId=serviceid
{
    "Domain": "domain.test.com",
    "Template": "tplv-serviceid-test",
    "Outputs": [
        "demo1.png"
    ],
    "ReqJson": {
        "req_key": "high_aes_general_v20",
        "prompt": "千军万马",
        "model_version": "general_v2.0"
    },
    "ModelAction": "CVSync2AsyncSubmitTask",
    "ModelVersion": "2022-08-31"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateCVImageGenerateTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "7418048504813240370",
        "RespJson": {
            "code": 10000,
            "data": {
                "task_id": "7418048504813240370"
            },
            "message": "Success",
            "request_id": "2024092411365866C579D2A96A35DA62A9",
            "status": 10000,
            "time_elapsed": "23.099216ms"
        }
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。