You need to enable JavaScript to run this app.
文档中心
文档备案控制台
veImageX

veImageX

请输入
  • 文档首页
    • veImageXAPI 参考AI 能力组件 2.0创建 AI 图像处理任务（同步）
复制全文
下载 pdf
我的收藏
AI 能力组件 2.0
创建 AI 图像处理任务（同步）
复制全文
下载 pdf
我的收藏
创建 AI 图像处理任务（同步）

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

注意事项

  • 请求频率：单用户请求频率限制为 1 次/秒。

  • 超时时间：超时时间为 30 秒。

请求说明

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

请求参数

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

Query

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

Body

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

ServiceId

String

是

91**2g

服务 ID。

  • 您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

注意

确保该服务和您调用接口时使用的地域均为中国区（华北）cn-north-1。
该地域限制与您的服务器实际部署地域无关。即使服务器部署在海外，也可以调用该接口，但可能会有一定延迟。

WorkflowTemplateId

String

是

system_workflow_ai_super_resolution

AI 图像处理模板 ID。
AI 能力组件不同，模板 ID 不同，详见开发指南 > AI 能力组件 2.0 目录下的各组件文档。

WorkflowParameter

String

是

{"Input":{"ObjectKey":"example.webp","DataType":"uri"},"GenDREnhanceParam":{"ModelId":"ai_sr_model_v2","Multiple":1.2}}

AI 图像处理模板参数，需要将 JSON 压缩并转义为字符串。
AI 能力组件不同，参数取值不同，详见开发指南 > AI 能力组件 2.0 目录下的各组件文档。

返回参数

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

参数类型示例值描述

Output

String

{"ObjectKey":"veImageX-store/ai_super_resolution/67***a/example.webp","Size":54509,"Format":"webp"}

AI 图像处理结果，是 JSON 压缩并转义后的字符串。
AI 能力组件不同，参数取值不同，详见开发指南 > AI 能力组件 2.0 目录下的各组件文档。

请求示例 

POST https://imagex.volcengineapi.com/?Action=AIProcess&Version=2023-05-01
{
    "ServiceId": "91**2g",
    "WorkflowTemplateId": "system_workflow_ai_super_resolution",
    "WorkflowParameter": "{\"Input\":{\"ObjectKey\":\"example.webp\",\"DataType\":\"uri\"},\"GenDREnhanceParam\":{\"ModelId\":\"ai_sr_model_v2\",\"Multiple\":1.2}}"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AIProcess",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Output": "{\"ObjectKey\":\"veImageX-store/ai_super_resolution/67***a/example.webp\",\"Size\":54509,\"Format\":\"webp\"}"
    }
}

错误码

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

最近更新时间：2026.03.31 11:54:14
这个页面对您有帮助吗？
有用
有用
无用
无用