图片压缩与尺寸优化 - LLM Markdown

# 图片压缩与尺寸优化

> 来源页面: https://www.gugudata.com/api/details/image-compress

## 概览

- API 标识: `image-compress`
- 分类: 图像/转换
- 描述: 图片压缩与等比尺寸优化
- 标签: 图片压缩 / 图片优化 / 尺寸调整
- 短标签: 图片处理
- 详情页: https://www.gugudata.com/api/details/image-compress
- LLM Markdown: https://www.gugudata.com/api/details/image-compress/llm.md
- 数据预览: https://www.gugudata.com/preview/image-compress
- 购买开通: https://www.gugudata.com/order/image-compress
- APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders

## 给大模型的接入指令

如果你正在帮助用户接入这个 API，请优先使用本文档中的接口地址、请求方式、请求参数、返回参数、状态码、cURL 示例和预览数据生成代码或排查问题。

- 接入目标: 调用 `图片压缩与尺寸优化`，不要臆造未在文档中出现的参数或返回字段。
- AppKey 获取: 用户登录咕咕数据开发者中心后，在 `APP KEY 管理` 页面复制对应产品的 AppKey。
- AppKey 替换: 示例中的 `YOUR_APPKEY`、`APPKEY`、`{{YOUR_APPKEY}}`、`{{appkey}}`、`{{appKey}}` 都应替换为用户自己的 AppKey。
- AppKey 传递: 推荐使用 `X-GUGUDATA-APPKEY` 或 `X-API-Key` 请求头；OpenAI 兼容客户端可使用 `Authorization: Bearer <AppKey>`；历史 query 参数 `appkey` 继续有效。
- 开通与续费: 未开通时引导用户访问购买开通页；已开通或需要续费时，引导用户进入开发者中心或订单与续费页。
- 错误处理: HTTP 状态码代表传输层结果，响应体内的业务状态码代表接口业务结果，代码中应分别处理。
- 生产建议: AppKey 应保存在服务端环境变量或密钥配置中，由服务端统一发起请求，不要写入网页、App 客户端或公开仓库。

关键链接:

- 接口详情页: https://www.gugudata.com/api/details/image-compress
- LLM Markdown: https://www.gugudata.com/api/details/image-compress/llm.md
- 数据预览: https://www.gugudata.com/preview/image-compress
- 购买开通页: https://www.gugudata.com/order/image-compress
- 开发者中心 APP KEY 管理: https://www.gugudata.com/portal/
- 订单与续费: https://www.gugudata.com/portal/orders

## API 功能

- 支持上传本地图片或提交公开图片地址，直接获取压缩结果；
- 支持 JPEG、PNG、WebP、GIF 与 BMP 常见图片格式；
- 可按目标宽高或最大宽高等比缩放，避免图片拉伸变形；
- 支持多种输出格式，便于适配网站、移动端和内容平台；
- 可调节 JPEG 与 WebP 输出质量，平衡清晰度与文件体积；
- 保留 PNG、WebP 与 GIF 的透明效果，适合图标、海报和网页素材；
- 动态 GIF 与 WebP 在保持原格式时保留动画内容与播放节奏；
- 返回可直接保存、展示或继续传入业务系统的图片文件；
- 适合网站提速、移动端素材、内容管理和营销物料处理；
- 适合图片归档、上传前优化、素材适配与自动化处理流程；
- 默认最大 QPS:5，可在开发者中心自助升级，月付年付订单接口调用次数不限。
- [接口调用状态与状态监控](https://www.gugudata.com/status)

## API 文档

- 接口地址: `https://api.gugudata.com/ai/image-compress`
- 返回格式: `application/json; charset=utf-8`
- 请求方式: `POST`
- 请求协议: `HTTPS`
- 请求示例: `https://api.gugudata.com/ai/image-compress?appkey=YOUR_APPKEY`
- 接口测试: https://api.gugudata.com/ai/image-compress/demo
- Apifox: https://doc.gugudata.com/
- Postman: https://www.postman.com/gugudata/gugudata-official
- OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

## 鉴权方式

接口支持以下 AppKey 传递方式，任选一种即可；已有请求示例、Postman 集合和历史代码仍可继续使用原来的 `appkey` 参数方式。

| 传输载体 | 参数 | 示例 | 说明 |
| --- | --- | --- | --- |
| HTTP Header | `X-GUGUDATA-APPKEY` | `X-GUGUDATA-APPKEY: YOUR_APPKEY` | 推荐方式，适合服务端接入和统一封装。 |
| HTTP Header | `X-API-Key` | `X-API-Key: YOUR_APPKEY` | 通用 API Key Header，便于和常见 API 客户端集成。 |
| HTTP Header | `Authorization` | `Authorization: Bearer YOUR_APPKEY` | 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。 |
| Query 参数 | `appkey` | `?appkey=YOUR_APPKEY` | 兼容现有示例、Postman 集合、浏览器调试和历史代码。 |

> 部分历史 POST 接口仍兼容表单或 JSON body 中的 `appkey`；新接入建议优先使用 Header 或 Query 参数。

## 请求参数

| 参数名 | 参数类型 | 是否必须 | 默认值 | 备注 |
| --- | --- | --- | --- | --- |
| appkey | string | 是 | 无 | APPKEY，可通过 Query、multipart form、Header 或 Bearer 传递。 |
| image_file | string/binary | 否 | 无 | 本地图片文件，最大 10 MiB；与 image_url 二选一。 |
| image_url | string | 否 | 无 | 公开可访问的 HTTP 或 HTTPS 图片地址；与 image_file 二选一。 |
| targetWidth | integer | 否 | 无 | 目标宽度上限，范围为 1 至 8192 像素。 |
| targetHeight | integer | 否 | 无 | 目标高度上限，范围为 1 至 8192 像素。 |
| maxWidth | integer | 否 | 无 | 最大宽度，范围为 1 至 8192 像素。 |
| maxHeight | integer | 否 | 无 | 最大高度，范围为 1 至 8192 像素。 |
| quality | integer | 否 | 85 | JPEG 或 WebP 输出质量，范围为 1 至 95，默认 85。 |
| format | string | 否 | 无 | 输出格式：jpeg、png、webp、gif 或 bmp；未传时保持原格式。 |

## 返回参数

| 参数名 | 参数类型 | 备注 |
| --- | --- | --- |
| HTTP Header.Content-Type | string | 实际输出图片的 MIME 类型。 |
| HTTP Header.Content-Disposition | string | 包含建议下载文件名的响应头。 |
| Body(Binary) | string/binary | 压缩后的图片二进制文件。 |

## 接口常见 HTTP 响应状态码

> 以下为接口调用中常见的 HTTP 传输层状态码，不等同于响应体内的业务状态码；完整状态码注册表以 IANA HTTP Status Code Registry 为准。

| 状态码 | 状态码解释 | 备注 |
| --- | --- | --- |
| 200 | 请求成功 | HTTP 请求已成功处理；业务状态请结合响应体中的自定义业务码判断。 |
| 201 | 资源已创建 | 创建类接口请求成功，并已生成对应资源。 |
| 202 | 请求已接受 | 请求已被接受处理，结果可能异步完成。 |
| 204 | 无响应内容 | 请求成功但响应体为空，适用于无需返回数据的操作。 |
| 400 | 请求参数错误 | 请求参数缺失、格式错误或参数组合不合法。 |
| 401 | 认证失败 | 缺少、无效或未通过认证的访问凭证（如 AppKey）。 |
| 403 | 无权限访问 | 订单到期、权限不足或接口额度不可用。 |
| 404 | 资源不存在 | 请求路径不存在。 |
| 405 | 请求方法不允许 | 当前路径不支持该 HTTP 方法。 |
| 408 | 请求超时 | 客户端请求在服务端等待时间内未完成，可稍后重试。 |
| 409 | 请求冲突 | 请求与当前资源状态冲突，调整参数或业务状态后重试。 |
| 413 | 请求内容过大 | 上传文件或请求体超过接口限制。 |
| 414 | 请求地址过长 | 请求 URL 超过服务端可处理长度，建议减少查询参数或改用 POST。 |
| 415 | 请求内容类型不支持 | 上传或请求体的内容类型不符合接口要求。 |
| 422 | 请求语义错误 | 请求格式正确，但参数取值、语义或业务约束无法处理。 |
| 429 | 请求频率受限 | 默认按来源 IP 限速，单 IP 最多 5 QPS，可满足常规业务调用。超出限制时接口会返回 429 请求频率受限；已购买接口订单可加购 10 QPS 扩展。 |
| 431 | 请求头过大 | 请求头字段过大或过多，建议精简 Header 后重试。 |
| 500 | 服务器内部错误 | 服务端处理异常，请稍后重试。 |
| 502 | 服务暂时不可用 | 请稍后重试。 |
| 503 | 服务暂时不可用 | 请稍后重试。 |
| 504 | 请求超时 | 请稍后重试。 |

## 接口自定义业务状态码

| 业务状态码 | 业务状态码解释 | 备注 |
| --- | --- | --- |
| 100 | 请求成功 | 返回压缩后的图片文件。 |
| 501 | 参数或图片错误 | 请检查参数、图片地址、格式和大小。 |
| 502 | 请求频率受限 | 请稍后重试。 |
| 503 | 订单已到期 | 请检查接口服务有效期。 |
| 504 | APPKEY 错误 | 请检查 APPKEY 是否有效。 |
| 505 | 调用额度已用完 | 请检查剩余调用额度。 |
| 900 | 服务内部错误 | 请稍后重试。 |
| 901 | 图片服务暂时不可用 | 请稍后重试。 |

## cURL 请求示例

```bash
curl --location 'https://api.gugudata.com/ai/image-compress?appkey=YOUR_APPKEY' \
--form 'image_url=' \
--form 'targetWidth=' \
--form 'targetHeight=' \
--form 'maxWidth=' \
--form 'maxHeight=' \
--form 'quality=85' \
--form 'format=' \
--form 'image_file=@localfile_path.png'
```

## 常见问题 Q&A

### Q: 如何完成第一次 API 调用？
A: 先确认当前接口的请求方法、必填参数和成功状态，再使用对应产品的 AppKey 发起请求；以实际响应中的业务状态判断结果。 [查看接入指南](https://www.gugudata.com/developers/getting-started)

### Q: 如何保证请求时 AppKey 的安全性？
A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey，并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。

### Q: 接口可以用于哪些开发语言？
A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入；也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。

### Q: 请求失败或超时后可以重试吗？
A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求；超时并不表示服务端未执行，重试前需确认接口是否会重复计费或产生副作用。 [查看接入指南](https://www.gugudata.com/developers/errors-and-retries)

### Q: 接口的性能可以保证吗？
A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发，生产接入前完成联调与容量评估。

## 服务协议以及服务免责声明

- [服务协议](https://www.gugudata.com/license)
- [服务免责声明](https://www.gugudata.com/disclaimer)

## 技术支持

- 技术支持邮箱: support@gugudata.com
- 微信客服: https://work.weixin.qq.com/kfid/kfcf9a60a6afe3337b7