POST https://mediakit.cn-beijing.volces.com/api/v1/tools-sync/compress-image

本 API 用于提交一个同步的图像压缩任务。该工具提供一站式的图像体积优化方案，支持指定压缩质量、文件体积上限、输出格式转换（如 WebP, AVIF, HEIC）以及针对 PNG 格式的瘦身处理，适用于用户上传图片前的体积治理、AIGC 与多模态模型的媒体预处理、网站与 App 的图片分发加载优化等场景。

请求参数

Header 参数

参数	类型	是否必选	示例值	描述
Authorization	String	是	Bearer {Your_API_Key}	格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。

Body 参数

参数	类型	是否必选	示例值	描述
image_url	String	是	https://example.com/source.jpg	待处理的图片 URL。图像来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、火山引擎对象存储 (tos://) 三种输入协议。关于各协议的具体说明和使用示例，请参阅多源媒体输入与本地上传。文件大小：建议单张图片不超过 35 MB。支持格式：支持 .png、.jpg、.jpeg、.webp 等主流图像格式。仅支持处理静图。分辨率限制：输入图像的宽和高均不得超过 10000 像素。当输出格式指定为 avif 时，建议输入图像分辨率（宽 × 高）不要超过 100,000 像素，否则任务处理可能会失败。当输出格式指定为 heic 时，建议输入图像分辨率不要超过 4K（约 4096×4096 像素）时，否则任务处理可能会失败。
output_format	String	否	webp	输出图片的格式。支持以下取值： png jpeg webp avif heic 注意：若不提供此参数，默认值为 webp。如果希望保持原图格式，请显式传入原格式。
quality	Integer	否	75	压缩质量，取值范围 [1, 100]，默认为 75。数值越小，压缩率越高，图像质量损失越大。注意：设置了 max_size 时，此参数将被忽略。
max_size	Integer	否	204800	输出图像的文件体积上限，单位为字节（Byte）。例如，204800 表示 200 KB。推荐设为 10,485,760 字节（10 MiB）。设置此参数后，系统将自动调整压缩参数以尽可能满足该体积限制，此时您手动设置的 quality 值将被忽略。注意：仅当 output_format 为 jpeg 或 webp 时生效。
png_lossy	Boolean	否	true	是否对 PNG 图片启用有损压缩（PNG 瘦身），以获取更高的压缩率。默认为 false。注意：仅当 output_format 为 png 时生效。
queue_id	String	否	q00a9731598092652e4a95292434198	任务提交的目标队列 ID。如不传，默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列，以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列，系统会自动分配一个队列 ID。详情请参考项目与队列管理。

请求示例

以下示例演示了如何将一张图片压缩并转换为 WebP 格式，同时指定压缩质量为 80。

响应说明

这是一个同步接口，处理结果将直接在本接口的响应体中返回。

响应参数

参数	类型	描述
success	Boolean	任务是否成功。 true：成功。请查看 result 字段以获取任务结果。 false：失败。请查看 error 字段以获取详细错误信息。
result	Object	包含图像处理结果的对象，仅在 success 为 true 时返回。详见下文 Result 对象。
error	Object	错误详情对象，仅在 success 为 false 时返回。详见下文 Error 结构。
task_id	String	任务的唯一标识。
task_type	String	任务类型。
request_id	String	本次 API 请求的唯一标识，可用于问题排查。
expires_at	Integer	任务结果的过期时间戳（Unix Time，单位：秒）。仅当任务成功且有结果时返回。
queue_id	String	任务提交的目标队列 ID。

Result 对象

参数	类型	描述
image_url	String	处理后的图片文件下载地址。该地址的有效期为 24 小时，请务必及时保存产物。
image_size	Integer	生成图像的大小，单位为字节。
image_format	String	生成图像的格式，例如：webp。
image_width	Integer	生成图像的宽度，单位为 px。
image_height	Integer	生成图像的高度，单位为 px。

Error 对象

参数	类型	描述
code	String	具体的错误码，用于程序化识别错误类型。例如：InvalidParameter。关于各错误码的详细信息，请参阅错误码。
type	String	错误的宏观类型。例如：BadRequest。
message	String	对错误的详细描述，可用于开发调试。

响应示例

成功响应示例：

失败响应示例：

AI MediaKit