介绍

当前商品下的能力已支持通过同步转异步接口进行异步调用，整个调用流程分为两个步骤：1. 使用CVSync2AsyncSubmitTask接口提交任务；2. 使用CVSync2AsyncGetResult接口查询任务结果。
如有异步调用的需求，可参考本文档中提交任务与查询任务两个章节的示例进行调用。

能力列表

本商品下的能力都已支持同步转异步接口调用，下方列表中列举了部分能力

提交任务

提交任务请求参数

Header参数

完整公共参数列表见 公共参数
本服务Region为cn-north-1； Service为cv

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31

请求示例

请在能力列表中找到对应能力的接口文档，参考接口文档进行传参。下方示例为参考通用2.0Pro-文生图进行传参。
注：在提交任务时无需传入return_url 与logo_info 参数。

{
    "req_key":"high_aes_general_v20_L",
    "prompt":"千军万马",
    "model_version":"general_v2.0_L",
    "req_schedule_conf":"general_v20_9B_pe",
    "seed":-1,
    "scale":3.5,
    "ddim_steps":16,
    "width":512,
    "height":512,
    "use_sr":true,
}

提交任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务输出参数

重点关注data 字段，其他字段为公共返回

返回示例

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

查询任务

查询任务请求参数

Header参数

完整公共参数列表见 公共参数
本服务Region为cn-north-1； Service为cv

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31

Body参数

业务请求参数，放到request.body中，MIME-Type为application/json

ReqJson(序列化后的结果再赋值给req_json)

配置信息

LogoInfo

水印相关信息

请求示例

下方示例中req_key参数为参考通用2.0Pro-文生图接口文档中的算法名称进行传参。

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

查询任务返回参数

通用返回参数

请参考通用返回字段及错误码

业务输出参数

重点关注data 字段，其他字段为公共返回

返回示例

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

错误码

（1）通用错误码

请参考通用返回字段及错误码

（2）业务错误码

SDK使用说明

请参考SDK使用说明