You need to enable JavaScript to run this app.
导航
创建 AI 图像处理任务(异步)
最近更新时间:2025.03.28 15:43:35首次发布时间:2025.03.28 15:37:08
我的收藏
有用
有用
无用
无用

提交一条或多条 URL 或 URI 资源执行异步 AI 图像处理任务。

注意事项

  • 请求频率:单用户请求频率限制为 1 次/秒
  • 超时时间:超时时间为 10 秒
  • 服务地址:本接口仅支持在中国区域调用,对应 region 为 cn-north-1,详情参看调用方法

请求说明

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

请求参数

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

Query

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

Body

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

ServiceId

String

5s****fo

服务 ID。若 DataType 取值 uri,则提交的图片 URI 列表需在该服务内。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息
WorkflowTemplateldStringsystem_workflow_ai_super_resolutionAI 图像处理模板 ID。根据您需要的图像处理功能,参看 AI 图像处理模板页面获取模板 ID 和参数信息。
WorkflowParameterString{\"GenDREnhanceParam\":{\"Multiple\":1.2}}AI 图像处理模板参数,需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能,参看 AI 图像处理模板页面获取模板 ID 和参数信息。

DataType

String

uri

需要提交的图片数据类型,取值如下所示:

  • uri:指定 ServiceId 下存储 URI。
  • url:公网可访问的 URL。

DataList

Array of String

["a.png","uridemo.png"]

待进行 AI 处理的图片 URI 或 URL 列表,其中 URI 不需要带 tos-cn-i-*** 前缀。传入图片的短边不小于 256 px,长边不大于 2048 px,大小不超过 10 MB。

注意

DataType 取值 uri,则待转码图片 URI 必须为指定服务 ID 下的存储 URI。您可通过调用 GetImageUploadFiles 获取指定服务下全部的上传文件存储 URI。

CallbackConfObject of CallbackConf-任务回调配置,缺省情况下默认使用队列回调配置。

CallbackConf

参数类型是否必选示例值描述
MethodStringHTTP回调方式,仅支持取值 HTTP
EndpointStringhttps://demo.com回调 HTTP 请求地址,用于接收转码结果详情。支持使用 https 和 http 协议。
DataFormatStringJSON回调数据格式,仅支持取值 JSON
ArgsStringproduct id业务自定义回调参数,将在回调消息的 callback_args 中透传。具体回调参数请参考回调内容

Type

String

task

回调的维度类型,缺省情况下按照条目级别进行回调。取值如下所示:

  • task:将按照任务级别进行回调。可分批回调,一个批次内最多一次性可回调 5000 条图片转码条目执行信息。
  • entry:将按照条目级别进行回调。当该条目执行完毕,将立即产生回调。

返回参数

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

参数类型示例值描述
TaskIdString649b9d3****5537684010a7任务 ID。查询接口需要使用,请注意保存。
QueueIdString67d****队列 ID。查询接口需要使用,请注意保存。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageAITask&Version=2023-05-01
{
    "ServiceId": "5s****fo",
    "DataType": "uri",
    "WorkflowTemplateld": "system_workflow_ai_super_resolution",
    "WorkflowParameter": "{\"GenDREnhanceParam\":{\"Multiple\":1.2}}",
    "DataList": [
        "a.png",
        "uridemo.png"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageAITask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "649b9d3****5537684010a7",
        "QueueId": "67d****"
    }
}

错误码

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