—
Hyper3D Rodin 2.5 — Text to 3D
Rodin V2.5 by Hyper3D generates realistic and production ready 3D models from text or images.
Input
Add your inputs and customize the generation settings.
Result & Pricing
3d output — your generated 3d will appear here.
Your 3d will appear here
Choose your inputs and customize your settings.
Model pricing (tax excluded) per selected specification and add-ons
| Specification | Webot INR |
|---|---|
| base | ₹47.92 |
| HighPack addition | ₹95.85 |
Calculate credits in the input panel for your selected settings.
Prices, estimates and credit deductions exclude tax. Any applicable tax is charged only when you buy plans or credits.
Prices are converted to INR. Credits use your current plan rate.
- Prices shown are estimates, not final charges. Final billing details will be available in Reports after generation is complete.
API
WEBOT API · Text to 3D
Generate from your server with your WEBOT account credits.
Use your 120-character WEBOT customer key (a–z, A–Z, 0–9). Send
Authorization: Bearer YOUR_KEY. Keys are secrets: call from a server, never from public frontend code. Results come from verified webhooks and remain saved if your stream disconnects.1. Configure your server
WEBOT_BASE_URL=https://webot.online
WEBOT_API_KEY=<your-server-side-WEBOT-key>This base URL is resolved from verified domain mappings and your direct creator reseller. Forwarded Host headers are not trusted. New custom reseller domains need DNS, TLS and platform verification before activation.
2. Quote, then generate
| Method | Endpoint | Purpose |
|---|---|---|
| POST | https://webot.online/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote | Validate input and calculate credits (no deduction). |
| POST | https://webot.online/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests | Reserve quoted credits and queue an asynchronous job. |
| GET | https://webot.online/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests/{request_id}/result | Read your saved result: 202 pending, 200 terminal. |
| GET | https://webot.online/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests/{request_id}/events | Authenticated SSE: generation / terminal events. |
Send JSON {"input":{…}} to quote. Send the same input plus integer quoted_credits to generate, with Authorization: Bearer … and Idempotency-Key. Use a unique 16–128 character key per new job; persist it and reuse the same key and input on any uncertain response. Never retry with a new key: that creates a second chargeable job.
Credits are reserved only after validation and a durable request is saved. A changed quote or insufficient balance returns 409. Credits exclude purchase taxes. The quoted amount is an initial reservation. After generation, the final charge replaces it using confirmed usage. Any verified unused allocation becomes available automatically; additional usage may require more credits. Missing billing stays pending, including for failed jobs.
3. Input example
Save this as input.json. Replace sample prompts, files and media URLs with your own. Schemas do not guarantee provider acceptance of the content.
{
"prompt": "Audit sample text",
"quality_mesh_option": "Auto",
"is_micro": false,
"material": "All",
"texture_delight": false,
"hd_texture": false,
"TAPose": false,
"geometry_file_format": "glb",
"tier": "Gen-2.5-High",
"enable_creative_mode": false
}4. Language examples
# Save the model's example input as input.json, then replace prompts/media URLs.
# Requires curl and jq. Store NONCE once for this job; reuse it on any retry.
export NONCE="$(openssl rand -hex 16)"
BASE="${WEBOT_BASE_URL%/}"
jq -n --slurpfile input input.json '{input:$input[0]}' > quote-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote" \
-H "Authorization: Bearer $WEBOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @quote-body.json > quote.json
CREDITS=$(jq -er '.quote.credits_consumed' quote.json)
jq --argjson credits "$CREDITS" '. + {quoted_credits:$credits}' quote-body.json > request-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests" \
-H "Authorization: Bearer $WEBOT_API_KEY" -H "Idempotency-Key: $NONCE" \
-H 'Content-Type: application/json' --data-binary @request-body.json > job.json
# Subscribe; after a nonterminal disconnect, reconnect this SAME URL.
curl --fail-with-body -N "$(jq -er '.events_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"
# Read saved output after terminal notification (never call provider status/results).
curl --fail-with-body -sS "$(jq -er '.result_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path, body, nonce) {
const response = await fetch(base + path, {method:'POST', headers:{
Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
const json = await response.json();
if (!response.ok) throw new Error(JSON.stringify(json));
return json;
}
const {quote} = await post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote', {input});
const job = await post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
let buffer = '';
for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
buffer += chunk;
let end;
while ((end = buffer.indexOf('\n\n')) !== -1) {
const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
const data = event.split('\n').find(line => line.startsWith('data: '));
if (!data) continue;
const state = JSON.parse(data.slice(6));
if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
}
}
await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL!.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY!;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path: string, body: unknown, nonce?: string) {
const response = await fetch(base + path, {method:'POST', headers:{
Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
const json = await response.json();
if (!response.ok) throw new Error(JSON.stringify(json));
return json;
}
const {quote} = await post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote', {input});
const job = await post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
let buffer = '';
for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
buffer += chunk;
let end;
while ((end = buffer.indexOf('\n\n')) !== -1) {
const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
const data = event.split('\n').find(line => line.startsWith('data: '));
if (!data) continue;
const state = JSON.parse(data.slice(6));
if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
}
}
await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);# Python 3.9+, pip install requests
import json, os, time, uuid, requests
base = os.environ['WEBOT_BASE_URL'].rstrip('/')
headers = {'Authorization': 'Bearer ' + os.environ['WEBOT_API_KEY']}
with open('input.json', encoding='utf-8') as file:
input_data = json.load(file)
nonce = os.environ.get('WEBOT_JOB_NONCE') or str(uuid.uuid4()) # Persist before submitting.
def post(path, body, extra=None):
response = requests.post(base + path, headers={**headers, **(extra or {})}, json=body, timeout=180)
response.raise_for_status()
return response.json()
quote = post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote', {'input': input_data})['quote']
job = post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests', {'input': input_data, 'quoted_credits': quote['credits_consumed']}, {'Idempotency-Key': nonce})
state = job
while not state['terminal'] or state.get('financial_pending', False):
# Reconnect while nonterminal; this reads WEBOT's database, never a provider status API.
with requests.get(job['events_url'], headers=headers, stream=True, timeout=(10, 40)) as stream:
stream.raise_for_status()
for line in stream.iter_lines(decode_unicode=True):
if line and line.startswith('data: '):
state = json.loads(line[6:])
if 'status' not in state: raise RuntimeError(state)
if state['terminal'] and not state.get('financial_pending', False): break
if not state['terminal'] or state.get('financial_pending', False): time.sleep(1.5)
print(state['output'] if state['status'] == 'completed' else state['error'])<?php // PHP 8.1+ with cURL
$base = rtrim(getenv('WEBOT_BASE_URL'), '/');
$input = json_decode(file_get_contents('input.json'), false, 64, JSON_THROW_ON_ERROR);
$nonce = getenv('WEBOT_JOB_NONCE') ?: bin2hex(random_bytes(16)); // Persist this before submission.
function post(string $path, array $body, ?string $nonce = null): array {
global $base;
$headers = ['Authorization: Bearer '.getenv('WEBOT_API_KEY'), 'Content-Type: application/json'];
if ($nonce) $headers[] = 'Idempotency-Key: '.$nonce;
$ch = curl_init($base.$path);
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER=>true, CURLOPT_POST=>true,
CURLOPT_TIMEOUT=>180, CURLOPT_HTTPHEADER=>$headers,
CURLOPT_POSTFIELDS=>json_encode($body, JSON_THROW_ON_ERROR)]);
$raw = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch);
if ($raw === false || $status < 200 || $status >= 300) throw new RuntimeException('WEBOT HTTP '.$status);
return json_decode($raw, true, 64, JSON_THROW_ON_ERROR);
}
$quote = post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote', ['input'=>$input])['quote'];
$job = post('/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests', ['input'=>$input, 'quoted_credits'=>$quote['credits_consumed']], $nonce);
echo json_encode($job, JSON_PRETTY_PRINT); // Connect to events_url with the same Bearer header.// Go 1.20+; save as main.go.
package main
import ("bytes"; "encoding/json"; "fmt"; "io"; "net/http"; "os"; "strings"; "time"; "crypto/rand"; "encoding/hex")
func main() {
base := strings.TrimRight(os.Getenv("WEBOT_BASE_URL"), "/")
raw, err := os.ReadFile("input.json"); if err != nil { panic(err) }
nonce := os.Getenv("WEBOT_JOB_NONCE")
if nonce == "" { b := make([]byte,16); if _,err:=rand.Read(b);err!=nil {panic(err)}; nonce=hex.EncodeToString(b) }
// Persist nonce before the submission; reuse on ambiguous responses.
client := &http.Client{Timeout:180*time.Second}
post := func(path string, body any, id string) map[string]any {
data, err := json.Marshal(body); if err != nil {panic(err)}
req, err := http.NewRequest("POST",base+path,bytes.NewReader(data)); if err!=nil {panic(err)}
req.Header.Set("Authorization","Bearer "+os.Getenv("WEBOT_API_KEY")); req.Header.Set("Content-Type","application/json")
if id!="" {req.Header.Set("Idempotency-Key",id)}
res,err:=client.Do(req); if err!=nil {panic(err)}; defer res.Body.Close()
data,err=io.ReadAll(res.Body); if err!=nil {panic(err)}
if res.StatusCode<200||res.StatusCode>=300 {panic(string(data))}
var result map[string]any; if err=json.Unmarshal(data,&result);err!=nil {panic(err)}; return result
}
input:=json.RawMessage(raw)
quote:=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote",map[string]any{"input":input},"")["quote"].(map[string]any)
job:=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests",map[string]any{"input":input,"quoted_credits":quote["credits_consumed"]},nonce)
fmt.Println(job) // Stream events_url with the same Authorization header.
}// Java 11+, Jackson databind dependency; class Main in Main.java.
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.time.Duration;
import java.util.UUID;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.node.ObjectNode;
public class Main {
static final ObjectMapper json = new ObjectMapper();
static final HttpClient client = HttpClient.newHttpClient();
static final String base = System.getenv("WEBOT_BASE_URL").replaceAll("/$", "");
static JsonNode post(String path, JsonNode body, String nonce) throws Exception {
var b = HttpRequest.newBuilder(URI.create(base+path)).timeout(Duration.ofSeconds(180))
.header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY")).header("Content-Type","application/json")
.POST(HttpRequest.BodyPublishers.ofString(json.writeValueAsString(body)));
if(nonce!=null)b.header("Idempotency-Key",nonce);
var r=client.send(b.build(),HttpResponse.BodyHandlers.ofString());
if(r.statusCode()<200||r.statusCode()>=300)throw new IllegalStateException(r.body());
return json.readTree(r.body());
}
public static void main(String[] args) throws Exception {
var input=json.readTree(Files.readString(Path.of("input.json")));
ObjectNode body=json.createObjectNode();body.set("input",input);
var quote=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote",body,null).get("quote");
body.put("quoted_credits",quote.get("credits_consumed").asInt());
String nonce=System.getenv("WEBOT_JOB_NONCE");if(nonce==null)nonce=UUID.randomUUID().toString(); // Persist before POST.
var job=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests",body,nonce);System.out.println(job);
// Subscribe to job.events_url with Authorization; use BodyHandlers.ofLines().
}
}// .NET 8 console app, top-level statements.
using System.Net.Http;
using System.Text;
using System.Text.Json.Nodes;
var client = new HttpClient { Timeout = TimeSpan.FromSeconds(180) };
var root = Environment.GetEnvironmentVariable("WEBOT_BASE_URL")!.TrimEnd('/');
var key = Environment.GetEnvironmentVariable("WEBOT_API_KEY");
async Task<JsonNode> Post(string path, JsonNode body, string? nonce = null) {
using var req = new HttpRequestMessage(HttpMethod.Post, root + path);
req.Headers.Add("Authorization", "Bearer " + key);
if (nonce != null) req.Headers.Add("Idempotency-Key", nonce);
req.Content = new StringContent(body.ToJsonString(), Encoding.UTF8, "application/json");
using var res = await client.SendAsync(req);
var raw = await res.Content.ReadAsStringAsync();res.EnsureSuccessStatusCode();
return JsonNode.Parse(raw)!;
}
var input = JsonNode.Parse(await File.ReadAllTextAsync("input.json"));
var body = new JsonObject { ["input"] = input };
var quote = await Post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote", body);
body["quoted_credits"] = quote["quote"]!["credits_consumed"]!.GetValue<int>();
var nonce = Environment.GetEnvironmentVariable("WEBOT_JOB_NONCE") ?? Guid.NewGuid().ToString(); // Persist before submitting.
var job = await Post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests", body, nonce);
Console.WriteLine(job); // Subscribe to events_url with the same Bearer header and ResponseHeadersRead.# Ruby 3+, standard library only.
require 'net/http'
require 'json'
require 'securerandom'
base = ENV.fetch('WEBOT_BASE_URL').sub(%r{/$}, '')
post = lambda do |path, body, nonce = nil|
uri = URI(base + path)
req = Net::HTTP::Post.new(uri)
req['Authorization'] = 'Bearer ' + ENV.fetch('WEBOT_API_KEY')
req['Content-Type'] = 'application/json'
req['Idempotency-Key'] = nonce if nonce
req.body = JSON.generate(body)
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: 180) { |http| http.request(req) }
raise res.body unless res.is_a?(Net::HTTPSuccess)
JSON.parse(res.body)
end
input = JSON.parse(File.read('input.json'))
quote = post.call('/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote', {'input' => input})['quote']
nonce = ENV['WEBOT_JOB_NONCE'] || SecureRandom.uuid # Persist this before submission.
job = post.call('/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests', {'input' => input, 'quoted_credits' => quote['credits_consumed']}, nonce)
puts JSON.pretty_generate(job) # Subscribe to events_url with the same Authorization header.// Swift 5.9 server-side/CLI only. Do not embed customer keys in shipped apps.
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
@main struct Main {
static func main() async throws {
let env=ProcessInfo.processInfo.environment
let base=env["WEBOT_BASE_URL"]!.trimmingCharacters(in: CharacterSet(charactersIn:"/"))
let input=try JSONSerialization.jsonObject(with: Data(contentsOf:URL(fileURLWithPath:"input.json")))
func post(_ path:String,_ body:[String:Any],_ nonce:String?=nil) async throws -> [String:Any] {
var req=URLRequest(url:URL(string:base+path)!);req.httpMethod="POST";req.timeoutInterval=180
req.setValue("Bearer "+env["WEBOT_API_KEY"]!,forHTTPHeaderField:"Authorization")
req.setValue("application/json",forHTTPHeaderField:"Content-Type")
if let nonce {req.setValue(nonce,forHTTPHeaderField:"Idempotency-Key")}
req.httpBody=try JSONSerialization.data(withJSONObject:body)
let (data,res)=try await URLSession.shared.data(for:req)
guard let http=res as? HTTPURLResponse,(200..<300).contains(http.statusCode) else {throw NSError(domain:"WEBOT",code:1)}
return try JSONSerialization.jsonObject(with:data) as! [String:Any]
}
let quote=try await post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote",["input":input])["quote"] as! [String:Any]
let nonce=env["WEBOT_JOB_NONCE"] ?? UUID().uuidString // Persist before submission.
let job=try await post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests",["input":input,"quoted_credits":quote["credits_consumed"]!],nonce)
print(job) // Subscribe to events_url with the same Authorization header.
}
}// Server-side Kotlin/JVM 17+, Gradle dependencies: OkHttp 4.12, org.json 20240303.
import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody
import org.json.JSONObject
import java.io.File
import java.util.UUID
import java.util.concurrent.TimeUnit
fun main() {
val base=System.getenv("WEBOT_BASE_URL").trimEnd('/')
val client=OkHttpClient.Builder().readTimeout(180,TimeUnit.SECONDS).build()
fun post(path:String,body:JSONObject,nonce:String?=null):JSONObject {
val b=Request.Builder().url(base+path).header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY"))
.post(body.toString().toRequestBody("application/json".toMediaType()))
if(nonce!=null)b.header("Idempotency-Key",nonce)
return client.newCall(b.build()).execute().use {res ->
val raw=res.body!!.string();check(res.isSuccessful){raw};JSONObject(raw)
}
}
val body=JSONObject().put("input",JSONObject(File("input.json").readText()))
val quote=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/quote",body).getJSONObject("quote")
body.put("quoted_credits",quote.getInt("credits_consumed"))
val nonce=System.getenv("WEBOT_JOB_NONCE") ?: UUID.randomUUID().toString() // Persist before submission.
val job=post("/api/v1/models/creative_70899d74cf0c64eb91861e9b/requests",body,nonce)
println(job) // Subscribe to events_url with the same Authorization header.
}5. Receive all results
The response includes a stable WEBOT request_id, events_url and result_url. Subscribe with a Bearer-authenticated HTTP stream. Nonterminal streams end after 25 seconds; reconnect to the same URL after at least 1.5 seconds. Current saved state is replayed immediately, including completion that happened while disconnected. A terminal event contains the result envelope. The JSON terminal flag describes generation completion. Keep reconnecting while financial_pending is true; stop after the terminal event confirms financial settlement. Never poll provider status/results. Native browser EventSource cannot send a Bearer header; keep the key on your server.
Completed output contains the full model result, including every generated media/document item, not just the first URL. Failed output is null with error and refund_state. Results are strictly limited to the key owner, including on reseller domains. Model-independent aliases: /api/v1/requests/{request_id}/result and /events. Revoking a key blocks subsequent reads and streams; saved results remain accessible with another valid key of the same account.
6. Schemas and parameter defaults
Required fields are marked with *. Required text must contain non-whitespace content. Defaults apply when an optional parameter is omitted; null, false, 0 and an empty array are distinct values. “No documented default” means WEBOT does not invent one. Examples are sample inputs, not defaults. WEBOT generation constraints can require an explicit value even when the provider publishes an automatic default.
Input schema · fields, constraints and defaults
| Parameter | Type | Required | Default when omitted | Description / constraints |
|---|---|---|---|---|
quality_mesh_option | string | No | "Auto" | 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. enum: ["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"] |
prompt | string | Yes * | No documented default | A textual prompt to guide model generation. Required for Text-to-3D mode. maxLength: 1024 |
is_micro | boolean | No | false | Generate finer micro-scale geometric detail. Only effective with `tier="Gen-2.5-Extreme-High"`. |
material | string | No | "All" | Material type. PBR: physically-based materials with realistic lighting. Shaded: baked lighting with no PBR maps. All: both PBR and Shaded variants. None: geometry only with no textures. enum: ["PBR","Shaded","All","None"] |
texture_delight | boolean | No | false | Removes baked lighting/highlights from the generated textures. |
hd_texture | boolean | No | false | Enables enhanced texture post-processing for higher visual fidelity. |
TAPose | boolean | No | false | Generate characters in T-pose or A-pose format, making them easier to rig and animate in 3D software. |
geometry_file_format | string | No | "glb" | Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb. enum: ["glb","usdz","fbx","obj","stl"] |
seed | integer | null | No | No documented default | Seed value for randomization, ranging from 0 to 65535. Optional. |
tier | string | No | "Gen-2.5-High" | Generation tier. Higher tiers produce more detailed meshes. See more info in the [documentation](https://developer.hyper3d.ai/api-specification/rodin-gen2.5#use-gen-2.5-generation-with-following-gen-2.5-tiers). Selecting Gen-2.5-Minimum will automatically configure to a minimum mode, where 50K Triangle is selected, taking priority over quality_mesh_option. enum: ["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"] |
enable_creative_mode | boolean | No | false | If enabled, the generation will have enhanced generative robustness while ensuring output consistency. This corresponds to `geometry_instruct_mode` being equal to `creative` on the Hyper3D API. |
texture_mode | string | null | No | No documented default | Texture generation quality. When unset, the API picks a default appropriate for the tier. |
addons | object | null | No | No documented default | Optional add-ons |
addons.variant0.high_pack | boolean | No | false | Selecting HighPack generates 4K resolution texture instead of the default 2K. In Quad mode, the number of faces becomes ~16× the count set in the quality parameter. |
bbox_condition | object | null | No | No documented default | This is a controlnet that controls the maximum sized of the generated model. |
bbox_condition.variant0.width | integer | No | 0The published default conflicts with the published limits. Enter a valid value when enabling this optional setting. | Width (x axis) dimension for the bounding box constraint. minimum: 1 · maximum: 2048 |
bbox_condition.variant0.height | integer | No | 0The published default conflicts with the published limits. Enter a valid value when enabling this optional setting. | Height (y axis) dimension for the bounding box constraint. minimum: 1 · maximum: 2048 |
bbox_condition.variant0.length | integer | No | 0The published default conflicts with the published limits. Enter a valid value when enabling this optional setting. | Length (z axis) dimension for the bounding box constraint. minimum: 1 · maximum: 2048 |
enable_safety_checker | boolean | No | true | Authorized callers may set false to request relaxed screening. |
{
"type": "object",
"properties": {
"quality_mesh_option": {
"default": "Auto",
"type": "string",
"description": "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:\n1. Gen-2.5-Minimum: 50K Triangle\n2. Gen-2.5-Extreme-Low: 50K Triangle\n3. Gen-2.5-Low: 50K Triangle\n4. Gen-2.5-Medium: 500K Triangle\n5. Gen-2.5-High: 500K Triangle\nGen-2.5-Extreme-High: 1M Triangle.",
"enum": [
"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"
],
"title": "Quality Mesh Option"
},
"prompt": {
"title": "Prompt",
"type": "string",
"description": "A textual prompt to guide model generation. Required for Text-to-3D mode.",
"maxLength": 1024,
"examples": [
"A futuristic robot with sleek metallic design."
]
},
"is_micro": {
"default": false,
"type": "boolean",
"description": "Generate finer micro-scale geometric detail. Only effective with `tier=\"Gen-2.5-Extreme-High\"`.",
"title": "Is Micro"
},
"material": {
"default": "All",
"type": "string",
"description": "Material type. PBR: physically-based materials with realistic lighting. Shaded: baked lighting with no PBR maps. All: both PBR and Shaded variants. None: geometry only with no textures.",
"enum": [
"PBR",
"Shaded",
"All",
"None"
],
"title": "Material"
},
"texture_delight": {
"default": false,
"type": "boolean",
"description": "Removes baked lighting/highlights from the generated textures.",
"title": "Texture Delight"
},
"hd_texture": {
"default": false,
"type": "boolean",
"description": "Enables enhanced texture post-processing for higher visual fidelity.",
"title": "Hd Texture"
},
"TAPose": {
"default": false,
"type": "boolean",
"description": "Generate characters in T-pose or A-pose format, making them easier to rig and animate in 3D software.",
"title": "T/A Pose"
},
"geometry_file_format": {
"default": "glb",
"type": "string",
"description": "Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb.",
"enum": [
"glb",
"usdz",
"fbx",
"obj",
"stl"
],
"title": "Geometry File Format"
},
"seed": {
"anyOf": [
{
"minimum": 0,
"type": "integer",
"maximum": 65535
},
{
"type": "null"
}
],
"description": "Seed value for randomization, ranging from 0 to 65535. Optional.",
"title": "Seed"
},
"tier": {
"default": "Gen-2.5-High",
"type": "string",
"description": "Generation tier. Higher tiers produce more detailed meshes. See more info in the [documentation](https://developer.hyper3d.ai/api-specification/rodin-gen2.5#use-gen-2.5-generation-with-following-gen-2.5-tiers). Selecting Gen-2.5-Minimum will automatically configure to a minimum mode, where 50K Triangle is selected, taking priority over quality_mesh_option.",
"enum": [
"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"
],
"title": "Tier"
},
"enable_creative_mode": {
"default": false,
"type": "boolean",
"description": "If enabled, the generation will have enhanced generative robustness while ensuring output consistency. This corresponds to `geometry_instruct_mode` being equal to `creative` on the Hyper3D API.",
"title": "Enable Creative Mode"
},
"texture_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"legacy",
"extreme-low",
"low",
"medium",
"high"
]
},
{
"type": "null"
}
],
"description": "Texture generation quality. When unset, the API picks a default appropriate for the tier.",
"title": "Texture Mode"
},
"addons": {
"anyOf": [
{
"type": "object",
"properties": {
"high_pack": {
"default": false,
"type": "boolean",
"description": "Selecting HighPack generates 4K resolution texture instead of the default 2K. In Quad mode, the number of faces becomes ~16\u00d7 the count set in the quality parameter.",
"title": "High Pack"
}
},
"x-webot-order-properties": [
"high_pack"
],
"title": "RodinGen25Addons"
},
{
"type": "null"
}
],
"description": "Optional add-ons"
},
"bbox_condition": {
"anyOf": [
{
"type": "object",
"properties": {
"width": {
"default": 0,
"minimum": 1,
"type": "integer",
"maximum": 2048,
"description": "Width (x axis) dimension for the bounding box constraint.",
"title": "Width"
},
"height": {
"default": 0,
"minimum": 1,
"type": "integer",
"maximum": 2048,
"description": "Height (y axis) dimension for the bounding box constraint.",
"title": "Height"
},
"length": {
"default": 0,
"minimum": 1,
"type": "integer",
"maximum": 2048,
"description": "Length (z axis) dimension for the bounding box constraint.",
"title": "Length"
}
},
"x-webot-order-properties": [
"width",
"height",
"length"
],
"title": "RodinGen25BbboxField"
},
{
"type": "null"
}
],
"description": "This is a controlnet that controls the maximum sized of the generated model."
},
"enable_safety_checker": {
"title": "Enable Safety Checker",
"type": "boolean",
"default": true,
"description": "Authorized callers may set false to request relaxed screening."
}
},
"required": [
"prompt"
],
"x-webot-order-properties": [
"prompt",
"tier",
"seed",
"geometry_file_format",
"material",
"quality_mesh_option",
"texture_mode",
"enable_creative_mode",
"hd_texture",
"texture_delight",
"is_micro",
"TAPose",
"bbox_condition",
"addons",
"enable_safety_checker"
],
"title": "RodinGen25TextTo3DInput"
}Output (inside result.output) schema · fields, constraints and defaults
| Parameter | Type | Required | Default when omitted | Description / constraints |
|---|---|---|---|---|
model_mesh | object | Yes * | No documented default | Generated 3D object file. |
model_mesh.file_size | integer | null | No | No documented default | The size of the file in bytes. |
model_mesh.content_type | string | null | No | No documented default | The mime type of the file. |
model_mesh.url | string | Yes * | No documented default | The URL where the file can be downloaded from. |
model_mesh.file_name | string | null | No | No documented default | The name of the file. It will be auto-generated if not provided. |
model_meshes | array | No | No documented default | Additional generated 3D object files returned by Hyper3D besides model_mesh. |
model_meshes[].file_size | integer | null | No | No documented default | The size of the file in bytes. |
model_meshes[].content_type | string | null | No | No documented default | The mime type of the file. |
model_meshes[].url | string | Yes * | No documented default | The URL where the file can be downloaded from. |
model_meshes[].file_name | string | null | No | No documented default | The name of the file. It will be auto-generated if not provided. |
textures | array | Yes * | No documented default | Generated textures for the 3D object. |
textures[].width | integer | null | No | No documented default | The width of the image in pixels. |
textures[].file_size | integer | null | No | No documented default | The size of the file in bytes. |
textures[].content_type | string | null | No | No documented default | The mime type of the file. |
textures[].url | string | Yes * | No documented default | The URL where the file can be downloaded from. |
textures[].height | integer | null | No | No documented default | The height of the image in pixels. |
textures[].file_name | string | null | No | No documented default | The name of the file. It will be auto-generated if not provided. |
seed | integer | Yes * | No documented default | Seed value used for generation. |
{
"type": "object",
"properties": {
"model_mesh": {
"type": "object",
"properties": {
"file_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "File Size",
"description": "The size of the file in bytes.",
"examples": [
4404019
]
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Type",
"description": "The mime type of the file.",
"examples": [
"image/png"
]
},
"url": {
"type": "string",
"description": "The URL where the file can be downloaded from.",
"title": "Url"
},
"file_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Name",
"description": "The name of the file. It will be auto-generated if not provided.",
"examples": [
"z9RV14K95DvU.png"
]
}
},
"required": [
"url"
],
"x-webot-order-properties": [
"url",
"content_type",
"file_name",
"file_size"
],
"title": "File",
"description": "Generated 3D object file.",
"examples": [
{
"url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
}
]
},
"model_meshes": {
"items": {
"type": "object",
"properties": {
"file_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "File Size",
"description": "The size of the file in bytes.",
"examples": [
4404019
]
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Type",
"description": "The mime type of the file.",
"examples": [
"image/png"
]
},
"url": {
"type": "string",
"description": "The URL where the file can be downloaded from.",
"title": "Url"
},
"file_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Name",
"description": "The name of the file. It will be auto-generated if not provided.",
"examples": [
"z9RV14K95DvU.png"
]
}
},
"required": [
"url"
],
"x-webot-order-properties": [
"url",
"content_type",
"file_name",
"file_size"
],
"title": "File"
},
"type": "array",
"description": "Additional generated 3D object files returned by Hyper3D besides model_mesh.",
"title": "Model Meshes"
},
"textures": {
"items": {
"type": "object",
"properties": {
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width",
"description": "The width of the image in pixels.",
"examples": [
1024
]
},
"file_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "File Size",
"description": "The size of the file in bytes.",
"examples": [
4404019
]
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Type",
"description": "The mime type of the file.",
"examples": [
"image/png"
]
},
"url": {
"type": "string",
"description": "The URL where the file can be downloaded from.",
"title": "Url"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height",
"description": "The height of the image in pixels.",
"examples": [
1024
]
},
"file_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Name",
"description": "The name of the file. It will be auto-generated if not provided.",
"examples": [
"z9RV14K95DvU.png"
]
}
},
"required": [
"url"
],
"description": "Represents an image file.",
"x-webot-order-properties": [
"url",
"content_type",
"file_name",
"file_size",
"width",
"height"
],
"title": "Image"
},
"type": "array",
"description": "Generated textures for the 3D object.",
"title": "Textures"
},
"seed": {
"type": "integer",
"description": "Seed value used for generation.",
"title": "Seed"
}
},
"required": [
"model_mesh",
"seed",
"textures"
],
"x-webot-order-properties": [
"model_mesh",
"model_meshes",
"seed",
"textures"
],
"title": "ObjectOutputv2"
}Errors and limits
401 invalid/expired/revoked key · 403 key scope or domain mismatch · 404 unavailable model or unowned request · 409 quote changed, balance, concurrency or idempotency conflict · 413 JSON exceeds 2 MB · 415 wrong content type · 422 invalid fields/media · 429 rate limit · 503 temporary/ambiguous submission. Respect Retry-After. Current limits per account: 12 quotes/submissions, 120 result reads and 8 stream connections per minute. One submission preparation at a time per account. Do not automatically regenerate failed jobs.
Your requests
Hyper3D Rodin 2.5 - Text to 3D · Your account only
Select Requests to load your history.
| Request ID | Created at (IST) | Status | Credits used | Refunded | Processing time | Report |
|---|
Your model analytics
Hyper3D Rodin 2.5 - Text to 3D · Request dates in IST
Select Analytics to load your metrics.
Request counts
Daily requests by their current status
Request outcomes
Completed, failed and pending requests
Credits used
Daily recorded charges before refunds
Processing time
Daily average for completed requests with recorded timing
Processing percentiles
Completed requests only · Time from submission to recorded completion
How to use Hyper3D Rodin 2.5 — Text to 3D
Describe an object and this model generates a 3D asset. A 3D asset has depth as well as height and width.
Required inputs
- Prompt: Your instructions to the model. Say what you want, include the important details and avoid contradictory directions. For a video, describe the action as well as the scene.
Workflow
- Prepare your source material and fill the required inputs above. Review the supported settings for this model.
- Sign in to calculate the credit estimate. Review the estimate before choosing Generate.
- Keep this model page open while the request runs. Completed results arrive in the result area; use the available player or download controls to review the output.
When to use this workflow
- Turn an object idea into a 3D draft.
- Create a starting point for a scene or design.
Key settings
- Prompt
- Your instructions to the model. Say what you want, include the important details and avoid contradictory directions. For a video, describe the action as well as the scene. Maximum characters: 1024
- Tier
- The model variant or processing mode. Names such as fast or pro indicate different variants, not a universal quality scale. Use the options listed here and compare a small sample. Supported choices: "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"
- Seed
- A starting number for the model’s randomness. Keeping the same seed and other settings can help compare variations, but identical results are not guaranteed across every model or update. Random or an omitted seed gives the tool more freedom to vary the result.
- Geometry File Format
- The file type of the saved result. Choose a format accepted by the app where you will use it. PNG can support transparency; JPEG generally does not. Available image, audio, video or 3D formats depend on this model. Supported choices: "glb", "usdz", "fbx", "obj", "stl"
- Material
- The surface colour, pattern or material instructions for a 3D asset. Texture describes the outer appearance; geometry describes the underlying shape. Supported choices: "PBR", "Shaded", "All", "None"
- Quality Mesh Option
- The mesh complexity or face-layout target. Heavier geometry can preserve more detail but may be slower to load; lighter geometry suits simpler or mobile scenes. Follow the documented counting unit. Supported choices: "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"