Hyper3DHyper3D Docs
API Specification

Rodin Gen-1/1.5

Generate a 3D asset with the Rodin Gen-1/1.5 tiers.

POST
/api/v2/rodin
AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v2/rodin" \  -F tier="Sketch"
{  "error": "NO_SUCH_TASK",  "message": "Submitted.",  "uuid": "123e4567-e89b-12d3-a456-426614174000",  "submit_time": "2019-08-24T14:15:22Z",  "jobs": {    "uuids": [      "52faea01-729e-4195-85e8-6050a65315e3"    ],    "subscription_key": "string"  },  "consumed": 0.5,  "prompt": "string"}

Input

Choose one of the Sketch, Regular, Detail, or Smooth tiers. For Image-to-3D, submit one to five images; for Text-to-3D, submit prompt and omit images.

curl --fail-with-body --request POST 'https://api.hyper3d.com/api/v2/rodin' \
  --header "Authorization: Bearer ${RODIN_API_KEY}" \
  --form 'images=@./input.png' \
  --form 'tier=Regular' \
  --form 'mesh_mode=Quad' \
  --form 'quality=medium'

Multi-image behavior

  • condition_mode=concat treats the uploaded images as views of one object.

  • condition_mode=fuse combines features from images that may contain different objects.

  • mesh_mode accepts Quad or Raw and defaults to Quad.

  • quality selects a preset target face count and defaults to medium:

    • Quad: high 50000, medium 18000, low 8000, extra-low 4000.
    • Raw: high 50000, medium 18000, low 8000, extra-low 4000.
  • quality_override accepts a custom target face count from 500 to 200000 and takes precedence over quality.

Two options apply only to this generation: mesh_simplify simplifies Raw meshes and is on by default, while mesh_smooth smooths Quad meshes and is off by default. Add-on availability depends on the selected tier.

HighPack always upgrades pack textures from 2K to 4K. For Sketch and Regular in Quad mode, explicitly setting quality_override to 100000 or less also requests a high-poly model with about 16 times that face count. For Detail and Smooth, HighPack changes texture resolution only.

Pricing

ItemCharge
Base Gen-1/1.5 generation0.5 credits
addons includes HighPack+1.0 credits

Charges are additive. Base generation costs only 0.5 credits, and parameters not listed above do not incur additional charges.

Response and lifecycle

{
  "message": "Submitted.",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "jobs": {
    "uuids": ["223e4567-e89b-12d3-a456-426614174000"],
    "subscription_key": "subscription-key-from-generation-response"
  },
  "consumed": 0.5
}

Use jobs.subscription_key for Check Status and top-level uuid for Download Results. HTTP 201 means the endpoint handled the request; acceptance requires an absent or empty error and a non-empty top-level uuid. HTTP 400 indicates invalid fields/files, 401 indicates invalid authentication, and 429 indicates throttling.