bgCut.net API

只需一个 HTTPS 请求,即可在您的应用、网店或处理流程中移除背景。

基础 URL: https://bgcut.net/api/v1 · 获取密钥: API 密钥.

身份验证

每个请求都必须在 X-Api-Key 标头中携带您的 API 密钥。密钥可在账户中创建和吊销;每个密钥均可命名,便于按应用轮换。

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

也可以作为 Bearer 令牌发送: Authorization: Bearer bgc_…

POST /remove

可通过 multipart 文件、URL 或 base64 编码发送图片。默认返回处理后的图片(二进制)。

参数

参数类型说明
image_filefile图片文件(multipart/form-data)。支持 JPG、PNG、WebP、GIF、BMP、TIFF;最大 25 MB / 3000 万像素。
image_urlstring图片的公开 URL,用于抓取而非上传。
image_file_b64stringBase64 编码的图片(可带 data: 前缀)。
sizeauto | preview | fullpreview = 最大 640 px(使用每月免费额度,不消耗积分);full = 原始分辨率(1 积分);auto(默认)= 有积分时为 full,否则为 preview。
formatpng | jpg | webp输出格式。png 保留透明度;jpg 会以 bg_color(默认白色)为底色合并。
modelfast | hq | portraitfast(默认,约 1 秒)、hq(质量更高,速度较慢)、portrait(针对人像优化)。
bg_colorstring背景的十六进制颜色值,如 #ffffff。省略则为透明。
bg_blurnumber保留原始背景,但按此半径(单位为像素,1–200)进行模糊,例如设为 25 可获得人像模式效果。会覆盖 bg_color。
cropboolean将输出裁剪至主体边界框。
crop_margininteger裁剪时主体周围的额外边距,单位为像素(0–200)。
roistring感兴趣区域,以比例 x,y,w,h(0–1)表示。AI 仅识别该矩形内的内容,矩形外的部分均变为透明。
feathernumber按此半径(像素)柔化边缘(0–5)。
qualityintegerJPG/WebP 质量 50–100(默认 92)。
responsebinary | jsonbinary(默认)返回图片;json 返回元数据及 base64 图片。

响应

请求成功时返回 HTTP 200、图片字节及以下标头:

HTTP/1.1 200 OK
Content-Type: image/png
X-Credits-Charged: 1
X-Credits-Remaining: 149
X-Free-Remaining: 5
X-Width: 3000
X-Height: 2000
X-Image-Id: 1f3a…
X-Type: hd

使用 response=json 时,返回内容如下:

{
  "ok": true,
  "image": { "id": "1f3a…", "width": 3000, "height": 2000, "format": "png", "type": "hd", "bytes": 812345, "bbox": [120, 40, 2810, 1990], "data": "iVBORw0KGgo…" },
  "credits_charged": 1,
  "credits_remaining": 149,
  "free_remaining": 5
}

GET /account

curl https://bgcut.net/api/v1/account -H "X-Api-Key: bgc_…"

{ "ok": true, "email": "[email protected]", "credits": 149, "free_remaining": 5, "free_per_month": 5, "free_max_width": 640, "rate_limit_per_minute": 60 }

GET /images

返回使用您的 API 密钥处理的最近 100 张图片,并附带编辑器链接,可在浏览器中进一步精修。

错误

错误以 JSON 格式返回,包含错误代码和易于理解的说明:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerror说明
400bad_request / missing_image参数缺失或无效。
401auth_required / invalid_keyAPI 密钥缺失、无效或已被撤销。
402insufficient_credits / free_quota_exceeded积分不足(全尺寸)或免费额度已用完(预览)。
422too_large / bad_type / fetch_failed无法读取或下载该图片。
429rate_limited请求过于频繁,请降低请求频率,或联系我们提高限额。
500processing_failed服务端处理失败,不会向您扣费。

示例代码

所有示例均使用同一个端点。下载完整示例集: bgcut-api-examples.zip

限制

  • 每个 API 密钥每分钟最多 60 次请求(可申请更高限额)。
  • 单张图片最大 25 MB 且不超过 3000 万像素;超出的图片将被缩小。
  • 处理后的图片将保留 30 天,可在网页编辑器中进一步精修。
  • 失败的请求一律不扣费;如输出生成失败,已扣费用将自动退还。

开始集成

创建免费账户,生成密钥,一分钟内即可完成首次调用。

获取 API 密钥 价格