Sam 3D Body Serverless API

Reconstruct 3D human body meshes from a single photo.

~12.16s
POST /v2/sam-3d-body · 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-3d-body",
 9    image="https://segmind-resources.s3.amazonaws.com/input/e6c65a1e-563b-467e-bf2c-d4ef63609187-2_couple.png",
10    include_keypoints=False,
11    return_individual_meshes=False,
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/e6c65a1e-563b-467e-bf2c-d4ef63609187-2_couple.png",
23    "include_keypoints": False,
24    "return_individual_meshes": False,
25}
26job = client.submit_async("sam-3d-body", **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/sam-3d-body

Parameters

imagerequired
string (uri)

Upload an image with people for 3D mesh recovery. Use group photos or individual shots for varying detection results.

include_keypointsoptional
boolean

Toggle to include 3D/2D keypoints. Enable for detailed analysis or leave off for basic use.

Default: false
return_individual_meshesoptional
boolean

Choose to get separate mesh files per person. Ideal for personalized outputs; disable for a combined mesh.

Default: false

Response Type

Returns: 3D Model

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-3d-body

    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