Segment Anything Model Serverless API

The Segment Anything Model (SAM) produces high quality object masks from input prompts such as points or boxes, and it can be used to generate masks for all objects in an image.

POST /v2/sam-img2img · 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    "sam-img2img",
 9    image="https://segmind.com/kitchen.jpg",
10)
11print(result["status"])                      # COMPLETED
12print(result.get("output"))                  # model output (e.g. media URL)
13print(result["metrics"]["inference_time"])   # server compute seconds
14
15# --- Or submit + poll manually (track request_id, control the cadence) ---
16from segmind import SegmindClient, InferenceFailed, InferenceTimeout
17
18client = SegmindClient()                      # reads SEGMIND_API_KEY
19payload = {
20    "image": "https://segmind.com/kitchen.jpg",
21}
22job = client.submit_async("sam-img2img", **payload)
23print(job.request_id)                         # available immediately
24try:
25    result = job.wait(timeout=600, interval=1.0)
26except InferenceTimeout as e:
27    print("still running:", e.request_id)
28except InferenceFailed as e:
29    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/sam-img2img

Parameters

imagerequired
string (uri)

Image to Segment

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/sam-img2img

    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