Start building
SandBase

Appearance

Sam 3

POST/v1/run

Sam 3 3d Body is Meta's image-to-3D AI model. Transform photographs into production-ready 3D meshes with accurate geometry and texture mapping.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to meta/sam-3/3d-body.

Default: meta/sam-3/3d-body

stringimagerequired

URL of the image containing humans

Optional<string>mask

Optional URL of a binary mask image (white=person, black=background). When provided, skips auto human detection and uses this mask instead. Bbox is auto-computed from the mask.

Optional<boolean>include_mhr_params

Include the full MHR (Meta Human Representation) parameter set per person in the response metadata (shape, pose, expression, global rotations, joint coordinates, packed model params, raw pose). Set to `false` to return a leaner metadata block with only keypoints and camera parameters.

Default: true

Optional<boolean>export_meshes

Export individual mesh files (.ply) per person

Default: true

Optional<boolean>include_3d_keypoints

Include 3D keypoint markers (spheres) in the GLB mesh for visualization

Default: true

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-3d

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async