ব্যাকগ্রাউন্ড সরানোর API: একটি রিকোয়েস্ট পাঠান, তৈরি PNG পান।

আপনার ছবি পাঠান

POST /v1/remove চারটি উপায়ের যেকোনোটিতে ছবি নেয়। এর একটি পাঠান; কোনো রিকোয়েস্টে একাধিক থাকলে অগ্রাধিকার পায় image_file, তারপর image_file_b64, তারপর image_url, তারপর raw বডি। এই উদাহরণগুলো আপনার কী REMOVEBG_API_KEY এনভায়রনমেন্ট ভেরিয়েবল থেকে পড়ে (export REMOVEBG_API_KEY=… দিয়ে সেট করুন); ডাবল কোটেশন খেয়াল করুন, এতেই শেল মানটি বসিয়ে দেয়।

curl -X POST https://removebackground.dev/v1/remove \
  -H "x-api-key: $REMOVEBG_API_KEY" \
  -F 'image_file=@photo.jpg' \
  -o photo-no-bg.png

প্রতিটি উদাহরণ বডি একটি ফাইলে সেভ করে। স্ট্যাটাস 200 হলেই কেবল সেই ফাইলটি একটি ছবি; দেখুন রেসপন্স সামলান।

রেসপন্স সামলান

বেশিরভাগ একক ছবি একই রেসপন্সে তৈরি হয়ে ফিরে আসে। কিউ অস্বাভাবিক ব্যস্ত থাকলে এবং কোনো ছবিতে প্রায় 55 সেকেন্ডের বেশি লাগলে, এর বদলে আপনি একটি job id সহ 202 Accepted পাবেন। কাজটি চলতে থাকে: id দিয়ে এর ফলাফল আনুন। ছবি আবার পাঠালে দ্বিতীয় একটি কাজ শুরু হবে এবং দ্বিতীয় ক্রেডিট খরচ হতে পারে।

একটি সম্পূর্ণ উদাহরণ

তৈরি ছবি, 202, ব্যর্থ কাজ এবং লোকাল সময়সীমা সামলায়। এটি ছবি একবারই পাঠায় এবং শুধু নিরাপদ স্ট্যাটাস চেকগুলোই আবার চেষ্টা করে।

import os
import time
import uuid

import requests

API = "https://removebackground.dev"
KEY = os.environ["REMOVEBG_API_KEY"]  # keep the key on your server
EXT = {"image/png": ".png", "image/jpeg": ".jpg", "image/webp": ".webp"}


def save(res, stem):
    """Save an image response with the right extension; raise on anything else."""
    mime = res.headers.get("Content-Type", "").split(";")[0]
    if res.status_code != 200 or mime not in EXT:
        raise RuntimeError(f"HTTP {res.status_code}: {res.text[:500]}")
    path = stem + EXT[mime]
    with open(path, "wb") as f:
        f.write(res.content)
    return path


def remove_background(image_url, stem="result", max_wait=300):
    s = requests.Session()
    s.headers["x-api-key"] = KEY

    # One key per image: resending with the same key returns the same job, never a second
    # charge, so this POST is safe to retry after a timeout or a dropped connection.
    idem = {"Idempotency-Key": str(uuid.uuid4())}
    for attempt in range(3):
        try:
            res = s.post(f"{API}/v1/remove", data={"image_url": image_url}, headers=idem, timeout=(10, 120))
            break
        except requests.ConnectionError:
            if attempt == 2:
                raise
            time.sleep(2)
    if res.status_code != 202:
        return save(res, stem)  # 200 = the image; anything else raises

    # 202: still processing. Wait for the same job; never send the image again.
    job_id = res.json()["id"]
    deadline = time.monotonic() + max_wait
    while time.monotonic() < deadline:
        time.sleep(2)  # the API sends Retry-After: 2
        res = s.get(f"{API}/v1/jobs/{job_id}/result", timeout=30)
        if res.status_code == 409 and res.json()["error"]["code"] == "not_ready":
            continue
        return save(res, stem)  # the image, or the job's own error
    raise TimeoutError(f"Job {job_id} is still running. Check it later at /v1/jobs/{job_id}.")


print(remove_background("https://example.com/photo.jpg"))

• আপনার স্ক্রিপ্ট থামালে কাজ থামে না; সেটি শেষ হয়ে চার্জ হতে পারে। এর ফলাফল আপনার স্টুডিওতে দেখা যাবে।
• সময়সীমা আপনার পছন্দ, আমাদের প্রতিশ্রুতি নয়; বেশিরভাগ ছবি কয়েক সেকেন্ডেই শেষ হয়।
• remove.bg-কম্প্যাটিবল এন্ডপয়েন্ট ভিন্নভাবে কাজ করে: এটি কখনও 202 দেয় না (নিচে দেখুন)।

ব্যাচ, শুরু থেকে শেষ

1. জমা দিন

curl -X POST https://removebackground.dev/v1/batch \
  -H "x-api-key: $REMOVEBG_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{ "image_urls": ["https://example.com/front.jpg", "https://example.com/back.jpg"], "format": "png", "size": "hd" }'

100টি পর্যন্ত পাবলিক ছবির URL, সঙ্গে /v1/remove-এর যেকোনো অপশন। ওপরের দুটি প্লেসহোল্ডার URL আসল ছবি হলে সর্বোচ্চ 2 ক্রেডিট খরচ হতো। উত্তর সঙ্গে সঙ্গেই আসে:

202 Accepted
{
  "id": "3f6c2a9e-8d1b-4c7a-9e2f-5b8d0a1c4e77",
  "status": "queued",
  "total": 2,
  "invalid": 0,
  "duplicates": 0,
  "status_url": "https://removebackground.dev/v1/jobs/3f6c2a9e-8d1b-4c7a-9e2f-5b8d0a1c4e77"
}

invalid গোনে যেসব এন্ট্রি http(s) URL নয়, আর duplicates গোনে পুনরাবৃত্তি; দুটোই বাদ দেওয়া হয় এবং কখনও চার্জ হয় না। id সেভ করে রাখুন: রিস্টার্টের পর এটি দিয়েই কাজটি আবার ধরবেন।

2. কাজটি পোল করুন

done true না হওয়া পর্যন্ত কয়েক সেকেন্ড পরপর GET /v1/jobs/:id করুন। status queued থেকে processing-এ যায়, তারপর শেষ হয় succeeded, partial (কিছু ছবি ব্যর্থ) বা failed হিসেবে। যে আইটেম আবার চেষ্টা করা হচ্ছে সেটি retrying দেখায়।

{
  "id": "3f6c2a9e-…",
  "status": "partial",
  "done": true,
  "total": 2, "succeeded": 1, "failed": 1, "skipped": 0,
  "credits_charged": 1,
  "items": [
    { "position": 0, "input": "https://example.com/front.jpg", "status": "succeeded",
      "removal_id": "…", "width": 1600, "height": 1200, "format": "png",
      "result_url": "https://removebackground.dev/v1/jobs/3f6c2a9e-…/result?item=0" },
    { "position": 1, "input": "https://example.com/back.jpg", "status": "failed",
      "error": { "code": "fetch_failed", "message": "…" } }
  ]
}

3. প্রতিটি ফলাফল ডাউনলোড করুন

প্রতিটি সফল আইটেমের জন্য GET /v1/jobs/:id/result?item=N (অথবা এর result_url ব্যবহার করুন)। item হলো শূন্য থেকে শুরু হওয়া position। অবৈধ ও পুনরাবৃত্ত URL বাদ দেওয়ার পর পজিশনগুলো আপনার তালিকা অনুসরণ করে, তাই এর যেকোনো গণনা 0-এর বেশি হলে ফলাফল ইনডেক্স দিয়ে নয়, input দিয়ে মেলান।

• done true হলে একটি ব্যাচ আর 3টি খোলা ব্যাচের সীমায় গোনা হয় না।
• API-তে কোনো cancel এন্ডপয়েন্ট, webhook বা ZIP ডাউনলোড নেই। বাল্ক পেজ থেকে শুরু করা ব্যাচ সেখানেই বাতিল বা ZIP হিসেবে ডাউনলোড করা যায়।

রিট্রাই, ডুপ্লিকেট ও বিলিং

একটি Idempotency-Key পাঠান, তাহলে রিট্রাইয়ে দুবার চার্জ হবে না। POST /v1/remove বা POST /v1/batch-এ একটি Idempotency-Key হেডার যোগ করুন (255 অক্ষর পর্যন্ত যেকোনো অনন্য স্ট্রিং, যেমন একটি UUID), প্রতিটি ছবি বা ব্যাচের জন্য একটি কী। একই কী দিয়ে একই রিকোয়েস্ট আবার পাঠালে, প্রথমটি যে কাজ তৈরি করেছিল সেটিই পাবেন, Idempotent-Replayed: true সহ: নতুন কাজ নেই, নতুন চার্জও নেই, প্রথম রিকোয়েস্ট এখনও চলতে থাকলেও। একই কী ভিন্ন ছবি বা অপশনের সঙ্গে দিলে উত্তর আসে 409 idempotency_key_reused। কী আপনার অ্যাকাউন্টের এবং এর মেয়াদ শেষ হয় না।

কী ছাড়া, প্রতিটি POST একটি নতুন কাজ তৈরি করে, আর প্রতিটি সফল কাজে 1 ক্রেডিট খরচ হয় (remove.bg-কম্প্যাটিবল POST /v1.0/removebg-এ কী নেই)। একটি কাজ পড়া (GET /v1/jobs/…) সবসময় বিনামূল্যে এবং বারবার করা নিরাপদ।

IDEMPOTENCY_KEY=$(uuidgen)   # one per image; send the same one on every retry

curl -X POST https://removebackground.dev/v1/remove \
  -H "x-api-key: $REMOVEBG_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'image_file=@photo.jpg' \
  -o photo-no-bg.png

কীসে ক্রেডিট খরচ হয়

কখন আবার চেষ্টা করবেন

সীমা ও স্টোরেজ

ফলাফল কতদিন রাখা হয়

প্রতিটি ফলাফল তৈরির পর 48 ঘণ্টা আপনার অ্যাকাউন্টে গোপনে সংরক্ষিত থাকে, তারপর মুছে ফেলা হয়। ততক্ষণ আপনি GET /v1/jobs/:id/result দিয়ে বা আপনার স্টুডিও থেকে বিনামূল্যে আবার ডাউনলোড করতে পারেন। এরপর ফলাফলের লিংক উত্তর দেয় 410 result_unavailable; ছবিটি আবার প্রসেস করা একটি নতুন কাজ। ছবি মুছে যাওয়ার পরেও কাজের স্ট্যাটাস রেকর্ড পড়া যায়। আপলোড কীভাবে পরিচালনা করা হয় তা জানতে গোপনীয়তা নীতি দেখুন; মডেল প্রশিক্ষণে আমরা আপনার ছবি ব্যবহার করি না।

নিরাপত্তা

আপনার API কী আপনার নিয়ন্ত্রণে থাকা সার্ভারে রাখুন। ব্রাউজার কোড, মোবাইল অ্যাপ, পাবলিক রিপোজিটরি বা URL-এ রাখবেন না। আপনার নিজের ব্যবহারকারীদের ব্যাকগ্রাউন্ড সরাতে দিতে, তাদের ছবি আপনার ব্যাকএন্ডের মাধ্যমে পাঠান এবং সেখানে নিজস্ব সাইন-ইন ও খরচের সীমা যোগ করুন।

• API-তে CORS চালু আছে, যাতে এটি টুল ও সার্ভার-সাইড কোড থেকে কাজ করে। তার মানে এই নয় যে ওয়েব পেজে কী রাখা নিরাপদ: সেখানে যে কেউ এটি পড়তে পারে।
• একটি অ্যাকাউন্টের সব কী একই ক্রেডিট ব্যালেন্স খরচ করে। আপনার অ্যাকাউন্ট পেজে প্রতিটি অ্যাপ বা এনভায়রনমেন্টের জন্য আলাদা কী তৈরি করুন, যাতে একটি বাতিল করলে অন্যগুলো বন্ধ না হয়।
• কোনো কী ফাঁস হলে, সঙ্গে সঙ্গে অ্যাকাউন্ট পেজে সেটি বাতিল করুন (এটি তৎক্ষণাৎ কাজ বন্ধ করে) এবং নতুন একটি তৈরি করুন। আমরা প্রতিটি কী-এর শুধু একটি হ্যাশ রাখি, তাই এটি আপনাকে আর দেখাতে পারি না।

সমস্যা সমাধান