Hyper3DHyper3D Docs
API 规范

Rodin Gen-1/1.5

使用 Rodin Gen-1/1.5 tier 生成 3D asset。

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"}

输入

SketchRegularDetailSmooth 中选择一个 tier。Image-to-3D 提交一到五个 images;Text-to-3D 提交 prompt,并省略 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'

多图行为

  • condition_mode=concat 把上传图片视为同一物体的多个视角。

  • condition_mode=fuse 融合可能包含不同物体的多张图片中的特征。

  • mesh_mode 可取 QuadRaw,默认为 Quad

  • quality 用于选择预设目标面数,默认为 medium

    • Quadhigh 50000、medium 18000、low 8000、extra-low 4000。
    • Rawhigh 50000、medium 18000、low 8000、extra-low 4000。
  • quality_override 用于设置 500 到 200000 之间的自定义目标面数,提交后优先于 quality

有两个选项仅适用于该系列:mesh_simplify 用于简化 Raw 网格,默认开启;mesh_smooth 用于平滑 Quad 网格,默认关闭。Add-on 的可用性取决于所选 tier。

HighPack 始终把 pack 纹理从 2K 升级到 4K。对于 Quad 模式的 SketchRegular,显式设置不超过 100000 的 quality_override 时,还会请求面数约为该值 16 倍的高模。对于 DetailSmooth,HighPack 只改变纹理分辨率。

计费

项目扣费
Gen-1/1.5 基础生成0.5 credits
addons 包含 HighPack+1.0 credits

各项费用累加计算。基础生成仅需 0.5 credits;除上表列出的参数外,其他参数均不会产生额外费用。

响应与生命周期

{
  "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
}

使用 jobs.subscription_key 查询状态,使用顶层 uuid 下载结果。HTTP 201 仅表示 endpoint 已处理请求;只有在 error 缺失或为空且顶层 uuid 非空时,任务才算已受理。400 表示字段或文件无效,401 表示鉴权无效,429 表示触发限流。