Sam3 Image Serverless API

Precise object segmentation and tracking in images.

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

API Endpoint

POSThttps://api.segmind.com/v1/sam3-image

Parameters

imagerequired
string (uri)

Input image to segment. Use a high-resolution image for better accuracy.

boxes_inputoptional
string

Bounding box to specify the object to segment, e.g. "[[100, 150, 200, 250]]".

Default: ""
max_masksoptional
integer

Limit on the number of masks returned. 0 means no limit.

Default: 0Range: 0 - 100
point_labels_inputoptional
string

Labels for each point: 1 = foreground, 0 = background.

Default: "[[1]]"
points_inputoptional
string

Point coordinates to specify the object to segment, e.g. "[[300, 400]]" or "[[150, 200], [300, 400]]" for multiple points.

Default: ""
points_per_sideoptional
integer

Density for automatic mask creation. Higher values produce finer detail.

Default: 32Range: 0 - 128
pred_iou_threshoptional
number

IoU score filter. Higher values enforce stricter mask quality.

Default: 0.88Range: 0.5 - 1
return_masksoptional
boolean

Return each detected mask separately.

Default: false
return_overlayoptional
boolean

Return the masks overlaid on the input image, for visual assessment.

Default: false
return_previewoptional
boolean

Return a combined preview mask for a quick results check.

Default: true
text_promptoptional
string

Optional text prompt to guide what the model segments, e.g. "animal", "plant".

Default: ""
thresholdoptional
number

Confidence threshold for detection. 0.5 gives balanced results.

Default: 0.5Range: 0.1 - 1

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/sam3-image

    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