Background Replace Serverless API

This model is capable of generating photo-realistic images given any text input, with the extra capability of inpainting the pictures by using a mask

~9.12s
POST /v2/bg-replace · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "bg-replace",
 9    image="https://segmind-sd-models.s3.amazonaws.com/outputs/bg_replace_input.jpg",
10    ref_image="https://segmind-sd-models.s3.amazonaws.com/outputs/bg_input_reference.jpg",
11    prompt="Pefume bottle placed on top of a rock, in a jungle",
12    negative_prompt="bad quality, painting, blur",
13    samples=1,
14    scheduler="DDIM",
15    num_inference_steps=25,
16    guidance_scale=7.5,
17    seed=12467,
18    strength=1,
19    cn_weight=0.9,
20    ip_adapter_weight=0.5,
21    base64=False,
22)
23print(result["status"])                      # COMPLETED
24print(result.get("output"))                  # model output (e.g. media URL)
25print(result["metrics"]["inference_time"])   # server compute seconds
26
27# --- Or submit + poll manually (track request_id, control the cadence) ---
28from segmind import SegmindClient, InferenceFailed, InferenceTimeout
29
30client = SegmindClient()                      # reads SEGMIND_API_KEY
31payload = {
32    "image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_replace_input.jpg",
33    "ref_image": "https://segmind-sd-models.s3.amazonaws.com/outputs/bg_input_reference.jpg",
34    "prompt": "Pefume bottle placed on top of a rock, in a jungle",
35    "negative_prompt": "bad quality, painting, blur",
36    "samples": 1,
37    "scheduler": "DDIM",
38    "num_inference_steps": 25,
39    "guidance_scale": 7.5,
40    "seed": 12467,
41    "strength": 1,
42    "cn_weight": 0.9,
43    "ip_adapter_weight": 0.5,
44    "base64": False,
45}
46job = client.submit_async("bg-replace", **payload)
47print(job.request_id)                         # available immediately
48try:
49    result = job.wait(timeout=600, interval=1.0)
50except InferenceTimeout as e:
51    print("still running:", e.request_id)
52except InferenceFailed as e:
53    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/bg-replace

Parameters

imagerequired
string (uri)

Input Image.

promptrequired
string

Prompt to render

ref_imagerequired
string (uri)

Reference Image

base64optional
boolean

Base64 encoding of the output image.

Default: false
cn_weightoptional
number

Scale for classifier-free guidance

Default: 0.9Range: 0 - 1
guidance_scaleoptional
number

Scale for classifier-free guidance

Default: 7.5Range: 1 - 25
ip_adapter_weightoptional
number

Scale for classifier-free guidance

Default: 0.5Range: 0 - 1
negative_promptoptional
string

Prompts to exclude, eg. 'bad anatomy, bad hands, missing fingers'

num_inference_stepsoptional
integer

Number of denoising steps.

Default: 25Range: 20 - 100
samplesoptional
integer

Number of samples to generate.

Default: 1Range: 1 - 4
scheduleroptional
string

Type of scheduler.

Default: "DPM2 Karras"
Allowed values (12 total):
"DDIM""DPM Multi""DPM Single""Euler a""Euler""Heun""DPM2 a Karras""DPM2 Karras""LMS""PNDM"+2 more
seedoptional
integer

Seed for image generation.

Default: -1Range: -1 - 999999999999999
strengthoptional
number

Scale for classifier-free guidance

Default: 1Range: 0 - 1

Response Type

Returns: Media File

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/bg-replace

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out