API reference · hyper3d

hyper3d/rodin/2.5/text-to-3d

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

Input Schema

9 parameters · 1 required · 8 optional

Parameter	Type	Required	Description
`prompt`	string	Required	A textual prompt to guide model generation. Required for Text-to-3D mode. · Max length: 1024
`seed`	integer	Optional	Seed (0–65535). · Min: 0 · Max: 65535
`tier`	string	Optional	Generation tier (quality / speed). · Options: 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" Gen-2.5-MinimumGen-2.5-Extreme-LowGen-2.5-LowGen-2.5-MediumGen-2.5-HighGen-2.5-Extreme-High
`TAPose`	boolean	Optional	Generate characters in T-pose or A-pose for rigging. · Default: false
`addons`	string	Optional	Optional add-on. HighPack (4K textures, high-poly) is billed +$0.80. · Options: HighPack HighPack
`material`	string	Optional	PBR, Shaded, All (both) or None. · Options: PBR, Shaded, All, None · Default: "All" PBRShadedAllNone
`hd_texture`	boolean	Optional	Enhanced texture post-processing. · Default: false
`quality_mesh_option`	string	Optional	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. · Options: 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" Auto4K Quad8K Quad18K Quad50K Quad100K Quad200K Quad2K Triangle20K Triangle50K Triangle150K Triangle500K Triangle1M Triangle2M Triangle
`geometry_file_format`	string	Optional	Output file format. · 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/2.5/text-to-3d",
    "tier": "Gen-2.5-High",
    "TAPose": false,
    "prompt": "A futuristic robot with sleek metallic design.",
    "material": "All",
    "hd_texture": false,
    "quality_mesh_option": "Auto",
    "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 Rodin 2.5 Text to 3D