Hyper3DHyper3D Docs
API 规范

Rodin Gen-2.5

使用 Rodin Gen-2.5 从图片或文本生成 3D 资产。

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.5-Extreme-Low"
{  "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"}

输入方式

Image-to-3D

提交一到五个 images。第一张图片用于材质生成。prompt 可选;省略时,服务会从图片推导提示信息。

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.5-Medium' \
  --form 'mesh_mode=Raw' \
  --form 'quality=medium'

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 'prompt=A small wooden treasure chest with brass trim' \
  --form 'tier=Gen-2.5-Medium' \
  --form 'mesh_mode=Raw' \
  --form 'quality=medium'

Tier

tier 为必传参数

请始终显式传入一个 Gen-2.5 tier。如果省略 tier,接口会回退到 Regular 并生成 Gen-1/1.5 资产。

tier 用于选择生成系列以及模型的细节表现能力。它与下面的网格和纹理参数相互独立:任一 tier 都可以与 schema 允许的任意 mesh_modequalitytexture_mode 组合使用。

Tier适用场景
Gen-2.5-Extreme-Low快速生成简单资产。
Gen-2.5-Low结构清晰的资产和小型硬表面道具。
Gen-2.5-Medium平衡结构与细节。
Gen-2.5-High更丰富的结构和更平滑的表面。
Gen-2.5-Extreme-High适合需要还原高频细节的资产。

Creative mode

Creative mode(geometry_instruct_mode=creative)在保持输出质量一致的同时,允许更灵活的生成。该模式适用于 Gen-2.5-Medium 及更高 tier。

HighPack 会把 pack 纹理从 2K 升级到 4K。对于 Gen-2.5,它不会改变几何体,也不会额外生成高模。

Texture mode

texture_mode 用于选择纹理生成的精细程度。texture_mode 的默认值取决于所选的 tier

Tier默认 texture_mode
Gen-2.5-Extreme-Lowextreme-low
Gen-2.5-Lowlow
Gen-2.5-Mediummedium
Gen-2.5-Highhigh
Gen-2.5-Extreme-Highhigh

如何生成 12K 纹理

纹理分辨率由 texture_modeaddons 共同决定。

项目纹理分辨率
基础生成2K
addons=HighPack4K
texture_mode=extreme-high6K
texture_mode=extreme-high + addons=HighPack12K

计费

项目扣费
Gen-2.5 基础生成0.5 credits
tier=Gen-2.5-Extreme-High+0.5 credits
addons 包含 HighPack+1.0 credits
texture_mode=extreme-high+2.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 仅表示接口已处理请求;只有在 error 缺失或为空且顶层 uuid 非空时,任务才算已受理。400 表示字段或文件无效,401 表示鉴权无效,429 表示触发限流。