Hyper3DHyper3D Docs
API Specification

Rodin Gen-2

Generate a 3D asset with the Rodin Gen-2 tier.

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="Gen-2"
{  "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

Set tier=Gen-2. For Image-to-3D, submit one to five images and optionally a prompt. For Text-to-3D, submit prompt and omit images.

tier is required

Always send tier=Gen-2. If tier is omitted, the endpoint falls back to Regular and generates a Gen-1/1.5 asset.

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=Gen-2' \
  --form 'mesh_mode=Raw' \
  --form 'quality=medium'

HighPack upgrades pack textures from 2K to 4K. For Gen-2 it does not change geometry or generate an additional high-poly model.

Pricing

ItemCharge
Base Gen-2 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.