Inpaint Mask Maker Serverless API

Real-Time Open-Vocabulary Object Detection

POST /v2/inpaint-mask-maker · 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    "inpaint-mask-maker",
 9    prompt="white horse",
10    image="https://segmind-sd-models.s3.amazonaws.com/display_images/inpaint-mask-maker-input.jpg",
11    invert_mask=False,
12    confidence_thresh=0.5,
13    iou_thresh=0.2,
14    return_mask=False,
15    grow_mask=10,
16    base64=False,
17)
18print(result["status"])                      # COMPLETED
19print(result.get("output"))                  # model output (e.g. media URL)
20print(result["metrics"]["inference_time"])   # server compute seconds
21
22# --- Or submit + poll manually (track request_id, control the cadence) ---
23from segmind import SegmindClient, InferenceFailed, InferenceTimeout
24
25client = SegmindClient()                      # reads SEGMIND_API_KEY
26payload = {
27    "prompt": "white horse",
28    "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/inpaint-mask-maker-input.jpg",
29    "invert_mask": False,
30    "confidence_thresh": 0.5,
31    "iou_thresh": 0.2,
32    "return_mask": False,
33    "grow_mask": 10,
34    "base64": False,
35}
36job = client.submit_async("inpaint-mask-maker", **payload)
37print(job.request_id)                         # available immediately
38try:
39    result = job.wait(timeout=600, interval=1.0)
40except InferenceTimeout as e:
41    print("still running:", e.request_id)
42except InferenceFailed as e:
43    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/inpaint-mask-maker

Parameters

imagerequired
string (uri)

Upload your input image

promptrequired
string

Prompt to render

base64optional
boolean

Base64 encoding of the output image.

Default: false
confidence_threshoptional
number

Lowering it reduces false positives and increases sensitivity to desired objects. Increasing it minimizes false positives and prevents identifying undesired objects.

Default: 0.5Range: 0 - 1
grow_maskoptional
integer

Selectively expand image regions

Default: 10Range: 0 - 100
invert_maskoptional
boolean

Refers to inverting the mask.

Default: false
iou_threshoptional
number

Lowering the value reduces bounding box overlap, making detection more stringent. Increasing it allows more overlap and adapts to a wider detection range.

Default: 0.2Range: 0 - 1
return_maskoptional
boolean

Check this to obtain the mask as the output.

Default: false

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/inpaint-mask-maker

    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