Furniture Staging Serverless API

Furniture Staging

PlaygroundHistory
API
Pricing
~34.78s
POST /v2/furniture-staging · 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    "furniture-staging",
 9    prompt="photo of a white table with plant pot placed on an interior",
10    main_image="https://i.ibb.co/z8pdz41/main-image.png",
11    overlay_image="https://i.ibb.co/bHhQFBq/overlay-image.png",
12    main_image_mask="https://i.ibb.co/GFxb3SX/main-image-mask.png",
13    overlay_image_mask="https://i.ibb.co/8cqzRHL/overlay-image-mask.png",
14    steps=25,
15    seed=42424242,
16    guidance=30,
17    image_format="png",
18    image_quality=95,
19)
20print(result["status"])                      # COMPLETED
21print(result.get("output"))                  # model output (e.g. media URL)
22print(result["metrics"]["inference_time"])   # server compute seconds
23
24# --- Or submit + poll manually (track request_id, control the cadence) ---
25from segmind import SegmindClient, InferenceFailed, InferenceTimeout
26
27client = SegmindClient()                      # reads SEGMIND_API_KEY
28payload = {
29    "prompt": "photo of a white table with plant pot placed on an interior",
30    "main_image": "https://i.ibb.co/z8pdz41/main-image.png",
31    "overlay_image": "https://i.ibb.co/bHhQFBq/overlay-image.png",
32    "main_image_mask": "https://i.ibb.co/GFxb3SX/main-image-mask.png",
33    "overlay_image_mask": "https://i.ibb.co/8cqzRHL/overlay-image-mask.png",
34    "steps": 25,
35    "seed": 42424242,
36    "guidance": 30,
37    "image_format": "png",
38    "image_quality": 95,
39}
40job = client.submit_async("furniture-staging", **payload)
41print(job.request_id)                         # available immediately
42try:
43    result = job.wait(timeout=600, interval=1.0)
44except InferenceTimeout as e:
45    print("still running:", e.request_id)
46except InferenceFailed as e:
47    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/furniture-staging

Parameters

main_imagerequired
string (uri)

The URL of the main image

Default: "https://i.ibb.co/z8pdz41/main-image.png"
main_image_maskrequired
string (uri)

The URL of the main image mask

Default: "https://i.ibb.co/GFxb3SX/main-image-mask.png"
overlay_imagerequired
string (uri)

The URL of the overlay image

Default: "https://i.ibb.co/bHhQFBq/overlay-image.png"
promptrequired
string

The main prompt describing the scene or subject

Default: "photo of a white table with plant pot placed on an interior"
guidanceoptional
integer

Guidance scale for adjusting adherence to the prompt

Default: 30Range: 1 - 50
image_formatoptional
string

The output image format

Default: "png"
image_qualityoptional
integer

The quality of the output image

Default: 95Range: 10 - 100
overlay_image_maskoptional
string (uri)

The URL of the overlay image mask

Default: "https://i.ibb.co/8cqzRHL/overlay-image-mask.png"
seedoptional
integer

Random seed for reproducibility

Default: 42424242
stepsoptional
integer

The number of steps for image processing

Default: 25Range: 10 - 100

Response Type

Returns: Image

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/furniture-staging

    Submit — returns request_id, status_url, response_url

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

    Poll — until COMPLETED or FAILED

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

    Result — final response body

Status states

QUEUED— Accepted, waiting for a worker
PROCESSING— Running on a worker
COMPLETED— Done — result body is ready
FAILED— Errored (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