bgCut.net API

HTTPSリクエスト1回で、自社のアプリ、ショップ、パイプラインから背景を削除できます。

ベースURL: https://bgcut.net/api/v1 · APIキーの取得先: API キー.

認証

すべてのリクエストで、X-Api-KeyヘッダーにAPIキーを含める必要があります。キーはアカウントで作成・無効化できます。各キーには名前を付けられるため、アプリケーションごとにローテーションできます。

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

または、Bearerトークンとして送信することもできます: Authorization: Bearer bgc_…

POST /remove

画像はマルチパートファイル、URL、またはBase64エンコードで送信します。デフォルトでは、処理結果の画像(バイナリ)がレスポンスとして返されます。

パラメーター

パラメーター種類説明
image_filefile画像ファイル(multipart/form-data)。JPG、PNG、WebP、GIF、BMP、TIFFに対応。最大25 MB / 30 MP。
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背景色の16進カラーコード(例:#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 件の画像を返します。ブラウザーで仕上げるためのエディター URL も含まれます。

エラー

エラーは、エラーコードとわかりやすいメッセージを含む 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 リクエストまで(ご要望に応じて上限を引き上げ可能)。
  • 1 画像あたり最大 25 MB・30 メガピクセルまで。これを超える画像は縮小されます。
  • 処理済みの画像は 30 日間保存され、Web エディターで仕上げることができます。
  • 失敗したリクエストには課金されません。出力の生成に失敗した場合、料金は自動的に返金されます。

連携を始めましょう

無料アカウントを作成してキーを発行すれば、1 分以内に最初の API 呼び出しを実行できます。

API キーを取得 料金