Start building
SandBase

Appearance

Hyper3D Rodin

POST/v1/run

Rodin is hyper3d'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 hyper3d/rodin.

Default: hyper3d/rodin

stringpromptrequired

A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode.

Default:

Optional<integer>seed

Seed value for randomization, ranging from 0 to 65535. Optional.

Range: 0 to 65535

Optional<string>condition_mode

For fuse mode, One or more images are required.It will generate a model by extracting and fusing features of objects from multiple images.For concat mode, need to upload multiple multi-view images of the same object and generate the model. (You can upload multi-view images in any order, regardless of the order of view.)

Allowed values: fuse, concat

Default: concat

Optional<string>tier

Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular.

Allowed values: Regular, Sketch

Default: Regular

Optional<boolean>use_hyper

Whether to export the model using hyper mode. Default is false.

Default: false

Optional<boolean>TAPose

When generating the human-like model, this parameter control the generation result to T/A Pose.

Default: false

Optional<string>geometry_file_format

Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb.

Allowed values: glb, usdz, fbx, obj, stl

Default: glb

Optional<array<string>>input_image_urls

URL of images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode.

Optional<array<integer>>bbox_condition

An array that specifies the dimensions and scaling factor of the bounding box. Typically, this array contains 3 elements, Length(X-axis), Width(Y-axis) and Height(Z-axis).

Optional<string>addons

Generation add-on features. Default is []. Possible values are HighPack. The HighPack option will provide 4K resolution textures instead of the default 1K, as well as models with high-poly. It will cost triple the billable units.

Optional<string>quality

Generation quality. Possible values: high, medium, low, extra-low. Default is medium.

Allowed values: high, medium, low, extra-low

Default: medium

Optional<string>material

Material type. Possible values: PBR, Shaded. Default is PBR.

Allowed values: PBR, Shaded

Default: PBR

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