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

使用说明

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

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

注意事项

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

请求说明

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

请求参数

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

Query

Body

{
    "req_key":"high_aes_general_v20",
    "prompt":"千军万马",
    "model_version":"general_v2.0",
    "seed":-1,
    "scale":3.5,
    "ddim_steps":16,
    "width":512,
    "height":512,
    "use_sr":true,
    "return_url":true,
    "logo_info": {
        "add_logo": false,
        "position": 0,
        "language": 0,
        "logo_text_content": "水印"
    }
}

返回参数

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

{
    "code": 10000,
    "data": {
        "task_id": "7418048504813240370"
    },
    "message": "Success",
    "request_id": "2024**62A9",
    "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": "千军万马",
        "model_version": "general_v2.0",
        "seed": -1,
        "scale": 3.5,
        "ddim_steps": 16,
        "width": 512,
        "height": 512,
        "use_sr": true,
        "return_url": true,
        "logo_info": {
            "add_logo": false,
            "position": 0,
            "language": 0,
            "logo_text_content": "这里是明水印内容"
        }
    },
    "ModelVersion": "2022-08-31",
    "ModelAction": "CVProcess",
    "Outputs": [
        "AI/demo.png"
    ]
}

返回示例

{
    "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"
        ]
    }
}

错误码

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

服务端 SDK

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

• Java SDK
• Golang SDK
• Python SDK