bgCut.net API
ఒకే HTTPS అభ్యర్థనతో మీ సొంత యాప్లు, షాప్లు లేదా పైప్లైన్ల నుండి బ్యాక్గ్రౌండ్లను తొలగించండి.
https://bgcut.net/api/v1 · మీ కీని ఇక్కడ పొందండి: API కీలు.ప్రామాణీకరణ
ప్రతి అభ్యర్థనలో మీ API కీ X-Api-Key హెడర్లో ఉండాలి. కీలను మీ ఖాతాలో సృష్టించవచ్చు, రద్దు చేయవచ్చు. ప్రతి అప్లికేషన్కు విడిగా మార్చుకునేందుకు వీలుగా ప్రతి కీకి పేరు పెట్టవచ్చు.
X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
లేదా దీన్ని Bearer టోకెన్గా పంపండి: Authorization: Bearer bgc_…
POST /remove
చిత్రాన్ని multipart ఫైల్గా, URLగా లేదా base64-ఎన్కోడ్ చేసి పంపండి. డిఫాల్ట్గా ప్రతిస్పందనగా ఫలిత చిత్రం (బైనరీ) వస్తుంది.
పారామితులు
| పారామీటర్ | రకం | వివరణ |
|---|---|---|
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-ఎన్కోడ్ చేసిన చిత్రం (ఐచ్ఛికంగా data: ప్రిఫిక్స్తో). |
size | auto | preview | full | preview = గరిష్ఠంగా 640 px (మీ ఉచిత నెలవారీ కోటాను వాడుతుంది, క్రెడిట్లు అవసరం లేదు); full = అసలు రిజల్యూషన్ (1 క్రెడిట్); auto (డిఫాల్ట్) = క్రెడిట్లు ఉంటే full, లేకపోతే preview. |
format | png | jpg | webp | అవుట్పుట్ ఫార్మాట్. png పారదర్శకతను నిలుపుతుంది; jpg ను bg_color పై ఫ్లాటెన్ చేస్తారు (డిఫాల్ట్ తెలుపు). |
model | fast | hq | portrait | lite (డిఫాల్ట్, ~6 సె, ఉత్తమ సమతుల్యం), fast (~0.5 సె, ప్రివ్యూ నాణ్యత), hq (~15 సె, గరిష్ఠ నాణ్యత), portrait (~0.3 సె, వ్యక్తులకు మాత్రమే). |
bg_color | string | నేపథ్యానికి హెక్స్ రంగు, ఉదా. #ffffff. పారదర్శక నేపథ్యం కోసం దీన్ని వదిలేయండి. |
bg_blur | number | అసలు నేపథ్యాన్ని అలాగే ఉంచి, దాన్ని ఈ వ్యాసార్థంతో (పిక్సెల్లలో, 1–200) బ్లర్ చేస్తుంది, ఉదా. పోర్ట్రెయిట్-మోడ్ లుక్ కోసం 25. ఇది bg_colorను అధిగమిస్తుంది. |
crop | boolean | అవుట్పుట్ను సబ్జెక్ట్ బౌండింగ్ బాక్స్కు క్రాప్ చేస్తుంది. |
crop_margin | integer | క్రాప్ చేసేటప్పుడు సబ్జెక్ట్ చుట్టూ ఉంచే అదనపు మార్జిన్, పిక్సెల్లలో (0–200). |
roi | string | ఆసక్తి ఉన్న ప్రాంతం, x,y,w,h భిన్నాలుగా (0–1). AI ఈ దీర్ఘచతురస్రం లోపల మాత్రమే చూస్తుంది; బయట ఉన్నదంతా పారదర్శకంగా మారుతుంది. |
feather | number | అంచులను ఈ వ్యాసార్థంతో (పిక్సెల్లలో, 0–5) మృదువుగా చేస్తుంది. |
quality | integer | JPG/WebP నాణ్యత 50–100 (డిఫాల్ట్ 92). |
response | binary | json | binary (డిఫాల్ట్) చిత్రాన్ని అందిస్తుంది; 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." }
| HTTP | error | వివరణ |
|---|---|---|
| 400 | bad_request / missing_image | పారామీటర్లు లేవు లేదా చెల్లనివి. |
| 401 | auth_required / invalid_key | API కీ లేదు, చెల్లదు లేదా రద్దు చేయబడింది. |
| 402 | insufficient_credits / free_quota_exceeded | క్రెడిట్లు లేవు (full సైజ్ కోసం) లేదా ఉచిత కోటా అయిపోయింది (preview కోసం). |
| 422 | too_large / bad_type / fetch_failed | చిత్రాన్ని చదవడం లేదా డౌన్లోడ్ చేయడం సాధ్యపడలేదు. |
| 429 | rate_limited | చాలా ఎక్కువ అభ్యర్థనలు – వేగం తగ్గించండి లేదా అధిక పరిమితుల కోసం మమ్మల్ని సంప్రదించండి. |
| 500 | processing_failed | మా వైపు ప్రాసెసింగ్ విఫలమైంది – మీకు ఛార్జ్ చేయబడదు. |
నమూనా కోడ్
అన్ని నమూనాలు ఒకే ఎండ్పాయింట్ను ఉపయోగిస్తాయి. పూర్తి ఉదాహరణల సేకరణను డౌన్లోడ్ చేయండి: bgcut-api-examples.zip
టైప్ చేసిన ఫలితాలు, ఎర్రర్ క్లాస్లు మరియు వెంటనే రన్ చేయగల ఉదాహరణలతో ఓపెన్-సోర్స్ క్లయింట్ లైబ్రరీ. MIT లైసెన్స్.
composer require bgcut-net/bgcut-phpపరిమితులు
- ప్రతి API కీకి నిమిషానికి 60 అభ్యర్థనలు (అభ్యర్థనపై అధిక పరిమితులు లభిస్తాయి).
- ప్రతి చిత్రానికి గరిష్ఠంగా 25 MB మరియు 30 మెగాపిక్సెల్లు; అంతకంటే పెద్ద చిత్రాల పరిమాణం తగ్గించబడుతుంది.
- ప్రాసెస్ చేసిన చిత్రాలు 30 రోజుల పాటు నిల్వ ఉంటాయి, వాటిని వెబ్ ఎడిటర్లో మెరుగుపరచవచ్చు.
- విఫలమైన అభ్యర్థనలకు ఎప్పుడూ ఛార్జ్ చేయబడదు; అవుట్పుట్ రూపొందించడం విఫలమైతే ఛార్జ్ స్వయంచాలకంగా వాపసు చేయబడుతుంది.
ఇంటిగ్రేషన్ ప్రారంభించండి
ఉచిత ఖాతాను సృష్టించి, కీని రూపొందించి, ఒక్క నిమిషం లోపే మీ మొదటి కాల్ చేయండి.
API కీ పొందండి ధరలు