提交一条或多条 URL 或 URI 资源执行异步 AI 图像处理任务。
cn-north-1
,详情参看调用方法。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateImageAITask | 接口名称。当前 API 的名称为 CreateImageAITask 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ServiceId | String | 是 |
| 服务 ID。若 |
WorkflowTemplateld | String | 是 | system_workflow_ai_super_resolution | AI 图像处理模板 ID。根据您需要的图像处理功能,参看 AI 图像处理模板页面获取模板 ID 和参数信息。 |
WorkflowParameter | String | 是 | {\"GenDREnhanceParam\":{\"Multiple\":1.2}} | AI 图像处理模板参数,需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能,参看 AI 图像处理模板页面获取模板 ID 和参数信息。 |
DataType | String | 是 |
| 需要提交的图片数据类型,取值如下所示:
|
DataList | Array of String | 是 |
| 待进行 AI 处理的图片 URI 或 URL 列表,其中 URI 不需要带 注意 若 |
CallbackConf | Object of CallbackConf | 否 | - | 任务回调配置,缺省情况下默认使用队列回调配置。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Method | String | 是 | HTTP | 回调方式,仅支持取值 HTTP 。 |
Endpoint | String | 是 | https://demo.com | 回调 HTTP 请求地址,用于接收转码结果详情。支持使用 https 和 http 协议。 |
DataFormat | String | 否 | JSON | 回调数据格式,仅支持取值 JSON 。 |
Args | String | 否 | product id | 业务自定义回调参数,将在回调消息的 callback_args 中透传。具体回调参数请参考回调内容。 |
Type | String | 否 |
| 回调的维度类型,缺省情况下按照条目级别进行回调。取值如下所示:
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TaskId | String | 649b9d3****5537684010a7 | 任务 ID。查询接口需要使用,请注意保存。 |
QueueId | String | 67d**** | 队列 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 错误码。