图像处理 API

将批图牛强大的 AI 抠图、图片变清晰、智能裁剪、背景替换与去水印能力，无缝集成到您的 ERP、CMS 或自动化工作流中。 通过 API Key 即可调用，按张计费，简单高效。

身份验证

API 使用 X-API-Key 请求头进行身份验证。 所有注册用户均可在 个人中心 → API 管理 创建和管理 API Key。

API 计费

调用流程

上传一张或多张图片文件。返回文件 ID 列表，用于后续创建处理任务。

Content-Type: multipart/form-data  |  单次上限: 50MB  |  格式: PNG、JPG、JPEG、WebP

curl -X POST https://api.ai-gptbot.com/api/files/upload \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "files=@product1.jpg" \
  -F "files=@product2.jpg"

请求参数

响应示例

[
  {
    "fileId": 10001,
    "originalName": "product1.jpg",
    "sizeBytes": 1024000,
    "url": "/api/files/10001/download"
  }
]

创建一个图像处理任务。传入上传后获得的文件 ID 和处理流水线配置，任务将异步执行。

curl -X POST https://api.ai-gptbot.com/api/tasks \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileIds": [10001, 10002],
    "pipeline": [
      { "action": "remove_watermark", "params": { "mode": "light" } },
      { "action": "enhance_image" },
      { "action": "remove_bg" },
      { "action": "replace_bg", "params": { "type": "color", "color": "#FFFFFF" } },
      { "action": "crop", "params": { "width": 800, "height": 800 } }
    ],
    "output": {
      "format": "png",
      "quality": 90,
      "enableRename": true,
      "filenamePrefix": "product",
      "maxFileSizeKb": 500
    }
  }'

请求参数

output 字段说明

响应示例

{
  "taskId": 50001
}

查询任务处理状态和结果。建议轮询间隔 2~5 秒，直到 status 为 2（成功）或 3（失败）。

curl https://api.ai-gptbot.com/api/tasks/50001 \
  -H "X-API-Key: YOUR_API_KEY"

响应示例

{
  "taskId": 50001,
  "status": 2,
  "totalCount": 2,
  "completedCount": 2,
  "failedCount": 0,
  "createdAtUtc": "2024-01-15T10:00:00Z",
  "startedAtUtc": "2024-01-15T10:00:05Z",
  "finishedAtUtc": "2024-01-15T10:00:30Z",
  "flags": { "blurred": false, "watermarked": false },
  "perImageResults": [
    {
      "taskItemId": 100001,
      "index": 0,
      "inputFileId": 10001,
      "inputUrl": "/api/files/10001/download",
      "status": 2,
      "previewUrl": "/api/files/20001/download",
      "outputUrl": "/api/files/20002/download",
      "errorMessage": null
    }
  ],
  "zipUrl": "/api/tasks/50001/zip"
}

响应字段说明

下载指定文件。可用于下载原始上传图片或处理结果图。响应为文件流（Content-Disposition: attachment）。

curl -O https://api.ai-gptbot.com/api/files/20001/download \
  -H "X-API-Key: YOUR_API_KEY"

将任务中所有处理结果打包为 ZIP 文件下载。适合批量处理场景。

curl -OJL https://api.ai-gptbot.com/api/tasks/50001/zip \
  -H "X-API-Key: YOUR_API_KEY"

根据文本提示词和目标尺寸，调用 AI 模型生成一张背景图片。生成后的图片可作为 replace_bg 步骤的 imageUrl 使用。

计费：每次生成消耗 1 积分  |  限流：每分钟最多 20 次

curl -X POST https://api.ai-gptbot.com/api/ai/generate-background \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "放在大理石桌面上，自然光，简洁干净的背景",
    "width": 1024,
    "height": 768
  }'

请求参数

响应示例

{
  "fileId": 10050,
  "url": "/api/files/10050/download",
  "width": 1024,
  "height": 768
}

响应字段说明

Pipeline 动作

pipeline 数组中的每个元素包含 action 和 params，按顺序执行。

枚举值

错误码

所有错误响应格式：{"code": "ERROR_CODE", "message": "错误描述"}