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 / 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 | portraitlite (ਡਿਫ਼ਾਲਟ, ~6 ਸਕਿੰਟ, ਸਭ ਤੋਂ ਵਧੀਆ ਸੰਤੁਲਨ), fast (~0.5 ਸਕਿੰਟ, ਪ੍ਰੀਵਿਊ ਗੁਣਵੱਤਾ), hq (~15 ਸਕਿੰਟ, ਵੱਧ ਤੋਂ ਵੱਧ ਗੁਣਵੱਤਾ), portrait (~0.3 ਸਕਿੰਟ, ਸਿਰਫ਼ ਲੋਕਾਂ ਲਈ)।
bg_colorstringਬੈਕਗ੍ਰਾਊਂਡ ਲਈ Hex ਰੰਗ, ਜਿਵੇਂ #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 ਰੂਪ ਵਿੱਚ ਮਿਲਦੀਆਂ ਹਨ, ਜਿਨ੍ਹਾਂ ਵਿੱਚ ਇੱਕ error ਕੋਡ ਅਤੇ ਆਸਾਨੀ ਨਾਲ ਪੜ੍ਹਨਯੋਗ ਸੁਨੇਹਾ ਹੁੰਦਾ ਹੈ:

{ "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

ਅਧਿਕਾਰਤ PHP SDK
ਟਾਈਪ ਕੀਤੇ ਨਤੀਜਿਆਂ, ਗਲਤੀ ਕਲਾਸਾਂ ਅਤੇ ਚਲਾਉਣ ਲਈ ਤਿਆਰ ਉਦਾਹਰਣਾਂ ਵਾਲੀ ਓਪਨ-ਸੋਰਸ ਕਲਾਇੰਟ ਲਾਇਬ੍ਰੇਰੀ। MIT ਲਾਇਸੈਂਸ।
composer require bgcut-net/bgcut-php
GitHub

ਸੀਮਾਵਾਂ

  • ਹਰ API ਕੁੰਜੀ ਲਈ ਪ੍ਰਤੀ ਮਿੰਟ 60 ਬੇਨਤੀਆਂ (ਮੰਗ ਕਰਨ 'ਤੇ ਵੱਧ ਸੀਮਾਵਾਂ ਉਪਲਬਧ)।
  • ਪ੍ਰਤੀ ਚਿੱਤਰ ਵੱਧ ਤੋਂ ਵੱਧ 25 MB ਅਤੇ 30 ਮੈਗਾਪਿਕਸਲ; ਵੱਡੇ ਚਿੱਤਰਾਂ ਦਾ ਆਕਾਰ ਘਟਾ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ।
  • ਪ੍ਰੋਸੈੱਸ ਕੀਤੇ ਚਿੱਤਰ 30 ਦਿਨਾਂ ਲਈ ਰੱਖੇ ਜਾਂਦੇ ਹਨ ਅਤੇ ਵੈੱਬ ਐਡੀਟਰ ਵਿੱਚ ਸੁਧਾਰੇ ਜਾ ਸਕਦੇ ਹਨ।
  • ਅਸਫਲ ਬੇਨਤੀਆਂ ਲਈ ਕਦੇ ਵੀ ਖਰਚਾ ਨਹੀਂ ਲਿਆ ਜਾਂਦਾ; ਜੇ ਆਉਟਪੁੱਟ ਬਣਾਉਣ ਵਿੱਚ ਅਸਫਲਤਾ ਹੋਵੇ ਤਾਂ ਖਰਚਾ ਆਪਣੇ-ਆਪ ਵਾਪਸ ਕਰ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ।

ਏਕੀਕਰਨ ਸ਼ੁਰੂ ਕਰੋ

ਮੁਫ਼ਤ ਖਾਤਾ ਬਣਾਓ, ਕੁੰਜੀ ਤਿਆਰ ਕਰੋ ਅਤੇ ਇੱਕ ਮਿੰਟ ਤੋਂ ਘੱਟ ਸਮੇਂ ਵਿੱਚ ਆਪਣੀ ਪਹਿਲੀ ਕਾਲ ਕਰੋ।

API ਕੁੰਜੀ ਪ੍ਰਾਪਤ ਕਰੋ ਕੀਮਤਾਂ