Sam 3D Object Serverless API
Single 2D image into detailed 3D object models.
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) 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
https://api.segmind.com/v1/sam-3d-objectsParameters
imagerequiredstring (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_boxoptionalstringSpecify object region with a bounding box. Example: [50, 75, 350, 400]
nullinclude_artifactsoptionalbooleanInclude processing artifacts in a ZIP for debugging. Enable for detailed analysis or disable for faster outputs.
falsemaskoptionalstring (uri)Use a mask image to specify 3D reconstruction regions. Optional for complex scenes, useful for precise object targeting.
nullpoint_coordsoptionalstringDefine object location with point coordinates. For ex: [[x1,y1]] or [[x1,y1],[x2,y2]]
nullpromptoptionalstringGuide object selection with a text prompt. Use 'bicycle' or 'tree' for specific object creation.
nullseedoptionalintegerSet a random seed for repeatability. Choose 123 for unique experiments or 42 for standard reproducible results.
123Range: 0 - 1000000Response 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
POST /v2/sam-3d-objectsSubmit — 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