API reference · hyper3d

hyper3d/rodin

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

Input Schema

12 parameters · 1 required · 11 optional

Parameter	Type	Required	Description
`prompt`	string	Required	A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode. · Max length: 1024 · Default: ""
`seed`	integer	Optional	Seed value for randomization, ranging from 0 to 65535. Optional. · Min: 0 · Max: 65535
`tier`	string	Optional	Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular. · Options: Regular, Sketch · Default: "Regular" RegularSketch
`TAPose`	boolean	Optional	When generating the human-like model, this parameter control the generation result to T/A Pose. · Default: false
`addons`	string	Optional	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.
`quality`	string	Optional	Generation quality. Possible values: high, medium, low, extra-low. Default is medium. · Options: high, medium, low, extra-low · Default: "medium" highmediumlowextra-low
`material`	string	Optional	Material type. Possible values: PBR, Shaded. Default is PBR. · Options: PBR, Shaded · Default: "PBR" PBRShaded
`use_hyper`	boolean	Optional	Whether to export the model using hyper mode. Default is false. · Default: false
`bbox_condition`	integer[]	Optional	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).
`condition_mode`	string	Optional	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.) · Options: fuse, concat · Default: "concat" fuseconcat
`input_image_urls`	string[]	Optional	URL of images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode.
`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",
    "tier": "Regular",
    "TAPose": false,
    "prompt": "A futuristic robot with sleek metallic design.",
    "quality": "medium",
    "material": "Shaded",
    "use_hyper": false,
    "condition_mode": "concat",
    "input_image_urls": [
      "https://static.sandbase.ai/examples/hyper3d/rodin/input_input_image_urls_0.png"
    ],
    "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 Rodin