本接口支持获取文生图异步任务生成的结果图 Url。

使用说明

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

1. 获取 veImageX 配置信息：服务 IDServiceId。
2. 获取创建完成的任务 ID。
3. 选择创建文生图异步任务时使用的豆包的文生图模型。
4. 根据所选模型对应的接口文档，完成 ModelAction、ModelVersion 和 ReqJson 这个三个参数的填写。

注意事项

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

请求说明

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

请求参数

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

Query

Body

{
    "req_key": "high_aes_general_v20_L",
    "task_id": "7418049665255653414",
    "req_json": "{
	    "logo_info":{
		    "add_logo":true,
		    "position":0,
		    "language":0,
		    "logo_text_content":"这里是明水印内容"
		    },
		  "return_url":true
		}"
}

返回参数

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

{
    "code": 10000,
    "data": {
        "binary_data_base64": [],
        "image_urls": [
            "https://xxx"
        ],
        "resp_data": "{
	        "pe_result":"",
	        "predict_tags_result":"",
	        "rephraser_result":"壮观***草原。",
	        "request_id":"ff**2"
	        }",
        "status": "done"
    },
    "message": "Success",
    "request_id": "2024***BE5",
    "status": 10000,
    "time_elapsed": "1.616183051s"
}

请求示例

POST https://imagex.volcengineapi.com/?Action=GetCVImageGenerateTask&Version=2023-05-01&ServiceId=serviceid
{
    "TaskId": "7418048504813240370",
    "ReqJson": {
        "req_key": "high_aes_general_v20_L",
        "task_id": "7418049665255653414",
        "req_json": "{\"logo_info\":{\"add_logo\":true,\"position\":0,\"language\":0,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true}"
    },
    "ModelAction": "CVSync2AsyncSubmitTask",
    "ModelVersion": "2022-08-31"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCVImageGenerateTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Status": "done",
        "ImageUrls": [
            "http://test.example.cn/tos-cn-i-serviceid/demo1~tplv-serviceid-image.image"
        ],
        "RespJson": {
            "code": 10000,
            "data": {
                "binary_data_base64": [],
                "image_urls": [
                    "https://xxx"
                ],
                "resp_data": "{\"pe_result\":\"\",\"predict_tags_result\":\"\",\"rephraser_result\":\"壮观的场景，展现了千军万马。画面中，穿着衣服的士兵们身着铠甲，手持长矛，整齐划一地行进在大地上。他们的身后是蓝天白云，而前方则是无尽的草原。\",\"request_id\":\"fffabb8c284a97530802576961c87939e9ab3b28b8a185f03e753420b1c9abe2\"}",
                "status": "done"
            },
            "message": "Success",
            "request_id": "20240926173705355DAC3521C41B25CBE5",
            "status": 10000,
            "time_elapsed": "1.616183051s"
        },
        "TaskId": "7418048504813240370"
    }
}

错误码

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

服务端 SDK

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

• Java SDK
• Golang SDK
• Python SDK