API 文档

一图一请求，直接获得白底图 URL

店小秘和现有 ERP 推荐使用同步接口。每次请求仍会建立任务记录、预占额度并保存成品，但不会进入队列等待。

1. 创建 API Key

登录控制台创建 Key，之后仍可在控制台复制。请保存在服务端或店小秘工具配置中，不能写入 URL。

打开控制台

2. 同步接口（店小秘推荐）

curl -X POST 'https://chimage.cn/api/image-background/v1/white-background' \ -H 'Authorization: Bearer wbg_live_xxx.yyy' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: product-10086-image-1' \ -d '{"image_url":"https://example.com/product.jpg"}'

成功返回 HTTP 200，并同时提供 url、image_url、white_background_url、result_url，便于兼容现有客户端。

3. 异步任务（批量系统可选）

大量并行图片可提交到 https://chimage.cn/api/image-background/v1/jobs，返回 202 后查询 status_url。店小秘的一图一请求不需要改用异步接口。

4. 状态码

  • 200：处理成功，扣 1 张。
  • 401：Key 无效或已停用。
  • 402：额度不足。
  • 409：幂等键冲突或相同任务正在处理。
  • 422：图片 URL 无效。
  • 429：请求过快。
  • 502：处理失败，不扣额度。

5. mtools 迁移

把旧地址替换为 https://chimage.cn/api/image-background/v1/white-background。请求 JSON 和成功返回的顶层 url 保持不变；历史 /api/v1/images/white-background 继续关闭。