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) 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
https://api.segmind.com/v1/inpaint-mask-makerParameters
imagerequiredstring (uri)Upload your input image
promptrequiredstringPrompt to render
base64optionalbooleanBase64 encoding of the output image.
falseconfidence_threshoptionalnumberLowering it reduces false positives and increases sensitivity to desired objects. Increasing it minimizes false positives and prevents identifying undesired objects.
0.5Range: 0 - 1grow_maskoptionalintegerSelectively expand image regions
10Range: 0 - 100invert_maskoptionalbooleanRefers to inverting the mask.
falseiou_threshoptionalnumberLowering the value reduces bounding box overlap, making detection more stringent. Increasing it allows more overlap and adapts to a wider detection range.
0.2Range: 0 - 1return_maskoptionalbooleanCheck this to obtain the mask as the output.
falseResponse 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
POST /v2/inpaint-mask-makerSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- 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.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out