Skip to content

Rodin 2.5 Image to 3D

POST/v1/run

Rodin Gen-2.5 by Hyper3D (Deemos) generates game- and production-ready 3D assets from one to five reference images.

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/2.5/image-to-3d.

Default: hyper3d/rodin/2.5/image-to-3d

Optional<string>prompt

Optional text prompt to guide generation.

array<string>imagesrequired

1 to 5 images of the object.

Optional<string>geometry_file_format

Output file format.

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

Default: glb

Optional<string>quality_mesh_option

Combined quality and mesh type selection. Quad = smooth surfaces, Triangle = detailed geometry. Maps to `mesh_mode` (Quad/Raw) and `quality_override` (face count) on the Hyper3D API. Valid face counts depend on the selected tier. Up to 1M Triangle is supported for tiers Extreme-Low, Low, and Medium. Up to 2M Triangle (as low as 20K Triangle) is supported for tiers High and Extreme-High. Auto option will choose the advised options for each tier: 1. Gen-2.5-Minimum: 50K Triangle 2. Gen-2.5-Extreme-Low: 50K Triangle 3. Gen-2.5-Low: 50K Triangle 4. Gen-2.5-Medium: 500K Triangle 5. Gen-2.5-High: 500K Triangle Gen-2.5-Extreme-High: 1M Triangle.

Allowed values: Auto, 4K Quad, 8K Quad, 18K Quad, 50K Quad, 100K Quad, 200K Quad, 2K Triangle, 20K Triangle, 50K Triangle, 150K Triangle, 500K Triangle, 1M Triangle, 2M Triangle

Default: Auto

Optional<string>addons

Optional add-on. HighPack (4K textures, high-poly) is billed +$0.80.

Allowed values: HighPack

Optional<boolean>TAPose

Generate characters in T-pose or A-pose for rigging.

Default: false

Optional<boolean>hd_texture

Enhanced texture post-processing.

Default: false

Optional<string>tier

Generation tier (quality / speed).

Allowed values: Gen-2.5-Minimum, Gen-2.5-Extreme-Low, Gen-2.5-Low, Gen-2.5-Medium, Gen-2.5-High, Gen-2.5-Extreme-High

Default: Gen-2.5-High

Optional<string>material

PBR, Shaded, All (both) or None.

Allowed values: PBR, Shaded, All, None

Default: All

Optional<integer>seed

Seed (0–65535).

Range: 0 to 65535

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