bgCut.net API
HTTPS တောင်းဆိုမှု တစ်ခုတည်းဖြင့် သင့်ကိုယ်ပိုင်အက်ပ်များ၊ ဆိုင်များ သို့မဟုတ် pipeline များမှ နောက်ခံများကို ဖယ်ရှားပါ။
https://bgcut.net/api/v1 · သင့် key ကို ရယူရန်: API ကီးများ.အထောက်အထားစိစစ်ခြင်း
တောင်းဆိုမှုတိုင်းတွင် သင့် API key ကို X-Api-Key header ထဲတွင် ထည့်ပေးရပါမည်။ Key များကို သင့်အကောင့်တွင် ဖန်တီးခြင်းနှင့် ပယ်ဖျက်ခြင်း ပြုလုပ်နိုင်ပါသည်။ အပလီကေးရှင်းတစ်ခုချင်းအလိုက် လဲလှယ်အသုံးပြုနိုင်ရန် key တစ်ခုစီကို အမည်ပေးနိုင်ပါသည်။
X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
သို့မဟုတ် Bearer token အဖြစ် ပေးပို့နိုင်ပါသည်- Authorization: Bearer bgc_…
POST /remove
ပုံကို multipart ဖိုင်၊ URL သို့မဟုတ် base64 encode လုပ်ထားသော ပုံစံဖြင့် ပေးပို့ပါ။ မူလသတ်မှတ်ချက်အရ ရလဒ်ပုံ (binary) ကို ပြန်ပေးပါသည်။
ပါရာမီတာများ
| ပါရာမီတာ | အမျိုးအစား | ဖော်ပြချက် |
|---|---|---|
image_file | file | ပုံဖိုင် (multipart/form-data)။ JPG, PNG, WebP, GIF, BMP, TIFF; အများဆုံး 25 MB / 30 MP။ |
image_url | string | အပ်လုဒ်လုပ်မည့်အစား ရယူမည့် ပုံ၏ အများသုံး URL။ |
image_file_b64 | string | Base64 encode လုပ်ထားသော ပုံ (data: prefix ပါနိုင်သည်)။ |
size | auto | preview | full | preview = 640 px အထိ (လစဉ် အခမဲ့ခွဲတမ်းကို သုံးသည်၊ credit မကုန်ပါ); full = မူလ resolution (1 credit); auto (မူလ) = credit ရှိလျှင် full၊ မရှိလျှင် preview။ |
format | png | jpg | webp | ထွက်ရှိမည့် ဖော်မတ်။ png သည် ဖောက်ထွင်းမြင်ရမှု (transparency) ကို ထိန်းသိမ်းသည်; jpg ကို bg_color (မူလ အဖြူ) ပေါ်တွင် ပေါင်းစပ်သည်။ |
model | fast | hq | portrait | lite (မူလ၊ ~6 s၊ အမျှတဆုံး), fast (~0.5 s၊ preview အရည်အသွေး), hq (~15 s၊ အမြင့်ဆုံး အရည်အသွေး), portrait (~0.3 s၊ လူပုံများအတွက်သာ)။ |
bg_color | string | နောက်ခံအတွက် Hex အရောင်၊ ဥပမာ #ffffff။ ဖောက်ထွင်းမြင်ရသော နောက်ခံအတွက် ချန်ထားပါ။ |
bg_blur | number | မူလနောက်ခံကို ထားရှိပြီး ဤ radius (pixel၊ 1–200) ဖြင့် ဝါးပေးသည်၊ ဥပမာ portrait-mode ပုံစံအတွက် 25။ bg_color ကို အစားထိုးသည်။ |
crop | boolean | ထွက်ပုံကို အဓိကအရာ၏ ဘောင်အတိုင်း ဖြတ်ညှပ်ပါ။ |
crop_margin | integer | ဖြတ်ညှပ်ရာတွင် အဓိကအရာပတ်လည် ထပ်ဆောင်း margin (pixel၊ 0–200)။ |
roi | string | စိတ်ဝင်စားသော ဧရိယာကို x,y,w,h အချိုး (0–1) ဖြင့် သတ်မှတ်ခြင်း။ AI သည် ဤထောင့်မှန်စတုဂံအတွင်းကိုသာ ကြည့်ပြီး အပြင်ဘက်ရှိ အရာအားလုံး ဖောက်ထွင်းမြင်ရပါမည်။ |
feather | number | အစွန်းများကို ဤ radius (pixel၊ 0–5) ဖြင့် ပျော့ပြောင်းစေသည်။ |
quality | integer | JPG/WebP အရည်အသွေး 50–100 (မူလ 92)။ |
response | binary | json | binary (မူလ) သည် ပုံကို ပြန်ပေးသည်; json သည် metadata နှင့် base64 ပုံကို ပြန်ပေးသည်။ |
တုံ့ပြန်မှုများ
အောင်မြင်သော တောင်းဆိုမှုများသည် ပုံ bytes နှင့် အောက်ပါ header များနှင့်အတူ 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 key များဖြင့် လုပ်ဆောင်ခဲ့သော နောက်ဆုံးပုံ 100 ကို ဘရောက်ဇာတွင် ပြင်ဆင်နိုင်မည့် editor URL နှင့်အတူ ပြန်ပေးပါသည်။
အမှားများ
အမှားများကို error code နှင့် ဖတ်ရှုနားလည်လွယ်သော မက်ဆေ့ချ်ပါသည့် JSON အဖြစ် ပြန်ပေးပါသည်-
{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
| HTTP | error | ဖော်ပြချက် |
|---|---|---|
| 400 | bad_request / missing_image | ပါရာမီတာ မပါရှိခြင်း သို့မဟုတ် မမှန်ကန်ခြင်း။ |
| 401 | auth_required / invalid_key | API key မပါရှိခြင်း၊ မမှန်ကန်ခြင်း သို့မဟုတ် ပယ်ဖျက်ထားခြင်း။ |
| 402 | insufficient_credits / free_quota_exceeded | Credit မရှိခြင်း (full size အတွက်) သို့မဟုတ် အခမဲ့ခွဲတမ်း ကုန်သွားခြင်း (preview အတွက်)။ |
| 422 | too_large / bad_type / fetch_failed | ပုံကို ဖတ်၍ သို့မဟုတ် ဒေါင်းလုဒ်လုပ်၍ မရပါ။ |
| 429 | rate_limited | တောင်းဆိုမှု များလွန်းနေသည် – နှေးနှေးပို့ပါ သို့မဟုတ် ပိုမြင့်သော ကန့်သတ်ချက်အတွက် ကျွန်ုပ်တို့ထံ ဆက်သွယ်ပါ။ |
| 500 | processing_failed | ကျွန်ုပ်တို့ဘက်တွင် လုပ်ဆောင်မှု မအောင်မြင်ပါ – သင့်ထံမှ ငွေကောက်ခံမည် မဟုတ်ပါ။ |
နမူနာကုဒ်
နမူနာအားလုံးသည် endpoint တစ်ခုတည်းကို အသုံးပြုပါသည်။ နမူနာစုစည်းမှု အပြည့်အစုံကို ဒေါင်းလုဒ်လုပ်ပါ- bgcut-api-examples.zip
typed ရလဒ်များ၊ error class များနှင့် ချက်ချင်း run နိုင်သော နမူနာများ ပါဝင်သည့် open-source client library။ MIT လိုင်စင်။
composer require bgcut-net/bgcut-phpကန့်သတ်ချက်များ
- API key တစ်ခုလျှင် တစ်မိနစ်ကို တောင်းဆိုမှု 60 ခု (တောင်းဆိုပါက ပိုမြင့်သော ကန့်သတ်ချက် ရနိုင်သည်)။
- ပုံတစ်ပုံလျှင် အများဆုံး 25 MB နှင့် 30 megapixel; ပိုကြီးသော ပုံများကို အရွယ်ချုံ့ပါမည်။
- လုပ်ဆောင်ပြီးသော ပုံများကို 30 ရက် သိမ်းဆည်းထားပြီး ဝဘ် editor တွင် ပြင်ဆင်နိုင်ပါသည်။
- မအောင်မြင်သော တောင်းဆိုမှုများအတွက် ငွေမကောက်ပါ; ရလဒ်ထုတ်လုပ်မှု မအောင်မြင်ပါက ကောက်ခံငွေကို အလိုအလျောက် ပြန်အမ်းပေးပါမည်။
ပေါင်းစပ်ခြင်း စတင်ပါ
အခမဲ့အကောင့် ဖွင့်ပြီး key ထုတ်ကာ တစ်မိနစ်အတွင်း ပထမဆုံး call ကို ပြုလုပ်ပါ။
API key ရယူပါ ဈေးနှုန်း