You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /veImageX/API 参考/ImageX-豆包AIGC/文生图（异步）/查询文生图异步任务
查询文生图异步任务
最近更新时间：2024.12.25 15:42:00首次发布时间：2024.11.08 11:15:13
我的收藏

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

使用说明

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

  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

参数类型是否必选示例值描述
ActionString是GetCVImageGenerateTask接口名称。当前 API 的名称为 GetCVImageGenerateTask。
VersionString是2023-05-01接口版本。当前 API 的版本为 2023-05-01。
ServiceIdString是serviceid指定要查询的服务 ID。

Body

参数类型是否必选示例值描述
TaskIdString是7418048504813240370指定文生图异步任务的任务 ID。

ModelAction

String

是

CVSync2AsyncSubmitTask

创建文生图任务时，使用的文生图系列模型的接口 Action 名称。
例如，使用查询通用 2.0L-文生图异步任务，则 ModelAction 需要取值为 CVSync2AsyncGetResult。

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",
    "task_id": "7418049665255653414"
}

说明

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

返回参数

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

参数类型示例值描述

Status

String

done

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

  • in_queue：任务已提交
  • generating：任务处理中
  • done：任务处理完成
  • not_found：任务未找到，可能原因是无此任务或任务已过期（12小时）
TaskIdString7418048504813240370任务 ID
ImageUrlsArray of String["http://test.example.cn/demo1~tplv-serviceid-image.image"]最终上传至 veImageX 服务的结果图访问 URL，数量为 1。
StoreUrisArray of String["tos-cn-i-serviceid/demo1"]结果图存储 URI，数量为 1。

RespJson

JSON Map

详见描述内取值示例

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

{
    "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/demo1~tplv-serviceid-image.image"
        ],
        "RespJson": {},
        "TaskId": "7418048504813240370",
        "StoreUris": [
            "tos-cn-i-serviceid/demo1"
        ]
    }
}

错误码

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

服务端 SDK

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