AI 图像处理（同步）--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

AI 图像处理（同步）

最近更新时间：2025.03.28 15:37:08首次发布时间：2025.03.28 15:37:08

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`91**2g`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
WorkflowTemplateId	String	是	`system_workflow_ai_super_resolution`	AI 图像处理模板 ID。根据您需要的图像处理功能，参看 AI 图像处理模板页面获取模板 ID 和参数信息。
WorkflowParameter	String	是	`{\"Input\":{\"ObjectKey\":\"example.webp\",\"DataType\":\"uri\"},\"GenDREnhanceParam\":{\"Multiple\":1.2}}`	AI 图像处理模板参数，需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能，参看 AI 图像处理模板页面获取模板 ID 和参数信息。

ServiceId

String

是

91**2g

服务 ID。

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

WorkflowTemplateId String 是 system_workflow_ai_super_resolution AI 图像处理模板 ID。根据您需要的图像处理功能，参看 AI 图像处理模板页面获取模板 ID 和参数信息。

WorkflowParameter String 是 {\"Input\":{\"ObjectKey\":\"example.webp\",\"DataType\":\"uri\"},\"GenDREnhanceParam\":{\"Multiple\":1.2}} AI 图像处理模板参数，需要将 JSON 压缩并转义为字符串。根据您需要的图像处理功能，参看 AI 图像处理模板页面获取模板 ID 和参数信息。

返回参数

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

参数	类型	示例值	描述
Output	String	`{\"ObjectKey\":\"veImageX-store/ai_super_resolution/67***/example.webp\",\"Size\":54509,\"Format\":\"webp\"}`	AI 图像处理结果，是 JSON 压缩并转义后的字符串。参看 AI 图像处理模板页面获取模板 ID 和参数信息，根据具体的工作流的说明进行解析。

请求示例

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\":{\"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***/example.webp\",\"Size\":54509,\"Format\":\"webp\"}"
    }
}

错误码

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