API reference · hyper3d

hyper3d/rodin/v2

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDhyper3d/rodin/v2

Input Schema

11 parameters · 1 required · 10 optional

Parameter	Type	Required	Description
`prompt`	string	Required	A textual prompt to guide model generation. Optional for Image-to-3D mode - if empty, AI will generate a prompt based on your images. · Max length: 1024 · Default: ""
`seed`	integer	Optional	Seed value for randomization, ranging from 0 to 65535. Optional. · Min: 0 · Max: 65535
`TAPose`	boolean	Optional	Generate characters in T-pose or A-pose format, making them easier to rig and animate in 3D software. · Default: false
`addons`	string	Optional	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.
`material`	string	Optional	Material type. PBR: Physically-based materials with realistic lighting. Shaded: Simple materials with baked lighting. All: Both types included. · Options: PBR, Shaded, All · Default: "All" PBRShadedAll
`bbox_condition`	integer[]	Optional	An array that specifies the bounding box dimensions [width, height, length].
`preview_render`	boolean	Optional	Generate a preview render image of the 3D model along with the model files. · Default: false
`input_image_urls`	string[]	Optional	URL of images to use while generating the 3D model. Required for Image-to-3D mode. Up to 5 images allowed.
`use_original_alpha`	boolean	Optional	When enabled, preserves the transparency channel from input images during 3D generation. · Default: false
`quality_mesh_option`	string	Optional	Combined quality and mesh type selection. Quad = smooth surfaces, Triangle = detailed geometry. These corresponds to `mesh_mode` (if the option contains 'Triangle', mesh_mode is 'Raw', otherwise 'Quad') and `quality_override` (the numeric part of the option) parameters in Hyper3D API. · Options: 4K Quad, 8K Quad, 18K Quad, 50K Quad, 2K Triangle, 20K Triangle, 150K Triangle, 500K Triangle · Default: "500K Triangle" 4K Quad8K Quad18K Quad50K Quad2K Triangle20K Triangle150K Triangle500K Triangle
`geometry_file_format`	string	Optional	Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb. · Options: glb, usdz, fbx, obj, stl · Default: "glb" glbusdzfbxobjstl

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "hyper3d/rodin/v2",
    "TAPose": false,
    "prompt": "A futuristic robot with sleek metallic design.",
    "material": "All",
    "preview_render": false,
    "input_image_urls": [
      "https://static.sandbase.ai/examples/hyper3d/rodin/v2/input_input_image_urls_0.png",
      "https://static.sandbase.ai/examples/hyper3d/rodin/v2/input_input_image_urls_1.png",
      "https://static.sandbase.ai/examples/hyper3d/rodin/v2/input_input_image_urls_2.png"
    ],
    "use_original_alpha": false,
    "quality_mesh_option": "500K Triangle",
    "geometry_file_format": "glb"
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to Hyper3d