Sam 3D Object Serverless API

Single 2D image into detailed 3D object models.

~31.72s
POST /v2/sam-3d-objects · 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-objects",
 9    image="https://segmind-resources.s3.amazonaws.com/input/574b0eaa-a474-47fd-8e48-9eb107f76d8e-car.png",
10    prompt="car",
11    seed=123,
12    include_artifacts=False,
13)
14print(result["status"])                      # COMPLETED
15print(result.get("output"))                  # model output (e.g. media URL)
16print(result["metrics"]["inference_time"])   # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient()                      # reads SEGMIND_API_KEY
22payload = {
23    "image": "https://segmind-resources.s3.amazonaws.com/input/574b0eaa-a474-47fd-8e48-9eb107f76d8e-car.png",
24    "prompt": "car",
25    "seed": 123,
26    "include_artifacts": False,
27}
28job = client.submit_async("sam-3d-objects", **payload)
29print(job.request_id)                         # available immediately
30try:
31    result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33    print("still running:", e.request_id)
34except InferenceFailed as e:
35    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/sam-3d-objects

Parameters

imagerequired
string (uri)

Provide an image as a URL, file path, or base64 string to create a 3D object. Use a vehicle image URL for car modeling.

bounding_boxoptional
string

Specify object region with a bounding box. Example: [50, 75, 350, 400]

Default: null
include_artifactsoptional
boolean

Include processing artifacts in a ZIP for debugging. Enable for detailed analysis or disable for faster outputs.

Default: false
maskoptional
string (uri)

Use a mask image to specify 3D reconstruction regions. Optional for complex scenes, useful for precise object targeting.

Default: null
point_coordsoptional
string

Define object location with point coordinates. For ex: [[x1,y1]] or [[x1,y1],[x2,y2]]

Default: null
promptoptional
string

Guide object selection with a text prompt. Use 'bicycle' or 'tree' for specific object creation.

Default: null
seedoptional
integer

Set a random seed for repeatability. Choose 123 for unique experiments or 42 for standard reproducible results.

Default: 123Range: 0 - 1000000

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-objects

    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