You need to enable JavaScript to run this app.
导航
文生图
最近更新时间:2024.11.15 13:53:28首次发布时间:2024.11.08 11:15:13

该接口支持调用豆包大模型中的智能生图 API 能力,并根据豆包模型请求信息生成相应的一张图片。同时您可指定 veImageX 的图片处理模板,对智能生成的图片进行进一步的个性化图片处理,并同步输出结果图。

使用说明

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

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetCVTextGenerateImage接口名称。当前 API 的名称为 GetCVTextGenerateImage
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

ServiceId

String

serviceid

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

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

Body

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

Domain

String

test.example.com

服务下绑定的域名,域名状态需正常可用。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取绑定的域名信息。
  • 您也可以通过 OpenAPI 的方式获取域名,具体请参考获取服务下全部域名

Template

String

tplv-serviceid-test.image

服务下创建的图片处理模板配置(不带~),指定后,将按照模板中的处理配置对豆包大模型生成的图片进行图片处理。
您可在 veImageX 控制台的处理配置页面,参考新建模板配置模板并获取模版信息,例如 tplv-f0****5k-test.image

Outputs

Array of String

["demo1"]

指定输出图片的文件名,输入限制如下所示:

  • 数组长度为 1,若指定多个文件名,仅第一个取值生效。
  • 不支持空格。
  • 不支持以/开头或结尾,不支持/连续出现,最大长度限制为 180 个字节。

ModelAction

String

CVProcess

文生图系列模型中选择一个本次调用的智能生图模型,并传入该模型对应接口的 Action 名称。
例如,使用通用 2.0L-文生图,则 ModelAction 需要取值为 CVSync2AsyncSubmitTask

ModelVersion

String

2022-08-31

文生图系列模型中选择一个本次调用的智能生图模型,并传入该模型对应接口的 Version 名称。
例如,使用通用 2.0L-文生图,则 ModelVersion 需要取值为 2022-08-31

ReqJson

JSON Map

详见描述内取值示例

文生图系列模型中选择一个本次调用的智能生图模型,并传入该模型对应接口的请求 JSON 字符串。
例如,使用通用 2.0L-文生图的必填参数,则 ReqJson 传值示例如下所示:

{
    "req_key":"high_aes_general_v20_L",
    "prompt":"千军万马"
}

说明

您可忽略 return_url,该参数的取值并不会影响最终返回的结果图地址的类型。

Overwrite

Boolean

true

是否覆盖服务下同名文件,取值如下所示:

  • false:(默认)不覆盖
  • true:覆盖

说明

请确保您已开启重名覆盖上传功能,否则,此处配置无效。

返回参数

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

参数类型示例值描述
ImageUrlsArray of String["http://test.example.cn/demo1~tplv-serviceid-image.image"]最终上传至 veImageX 服务的结果图访问 URL,数量为 1。
StoreUrisArray of String["tos-cn-i-serviceid/demo1"]最终上传至 veImageX 服务的结果图存储 URI,数量为 1。

RespJson

JSON Map

详见描述内取值示例

根据指定的文生图模型接口信息,接收的该接口响应的 JSON 数据。
例如,使用通用 2.0L-文生图,则 RespJson 接收到的响应信息示例为:

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

请求示例

POST https://imagex.volcengineapi.com/?Action=GetCVTextGenerateImage&Version=2023-05-01&ServiceId=serviceid
{
    "Domain": "test.example.com",
    "Template": "tplv-serviceid-test.image",
    "Overwrite": true,
    "ReqJson": {
        "req_key": "high_aes_general_v20",
        "prompt": "千军万马"
    },
    "ModelVersion": "2022-08-31",
    "ModelAction": "CVProcess",
    "Outputs": [
        "demo1"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCVTextGenerateImage",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "RespJson": {
            "code": 10000,
            "data": {
                "task_id": "7418048504813240370"
            },
            "message": "Success",
            "request_id": "2024092411365866C579D2A96A35DA62A9",
            "status": 10000,
            "time_elapsed": "23.099216ms"
        },
        "ImageUrls": [
            "http://test.example.cn/demo1~tplv-serviceid-image.image"
        ],
        "StoreUris": [
            "tos-cn-i-serviceid/demo1"
        ]
    }
}

错误码

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

服务端 SDK

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