Hyper3DHyper3D Docs
API 规范

Rodin Gen-1/1.5

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

POST
/api/v2/rodin

根据图片和/或文本提示生成网格与纹理。

Authorization

bearer
headerAuthorizationBearer <token>

Request Body

multipart/form-data
  1. body
images*array<>

用于生成的图片,最多 5 张。请求体中的上传顺序会被保留。Image-to-3D 至少需要一张图片;Text-to-3D 不提交此字段。

Items1 <= items <= 5
prompt?string
Lengthlength <= 1024
seed?integer

可选,随机种子。

Range0 <= value <= 65535
mesh_mode?string
Default"Quad"
Value in"Quad""Raw"
geometry_file_format?string

可选,控制生成模型的文件格式。

Default"glb"
Value in"glb""usdz""fbx""obj""stl"
condition_mode?string
Default"concat"
Value in"fuse""concat"
material?string
Default"PBR"
Value in"PBR""Shaded""All""Hybrid""None"
quality?string
Default"medium"
Value in"high""medium""low""extra-low"
quality_override?integer

可选。Gen-1/1.5 的自定义目标面数,取值范围为 500 到 200000。提交后优先于 quality。

Range500 <= value <= 200000
tier*string
Default"Regular"
Value in"Regular""Detail""Smooth""Sketch"
bbox_condition?array<>
Items3 <= items <= 3
addons?array<>
Default[]
TAPose?boolean

可选,对于类人型模型,使用适合动画的 T-pose 或 A-pose 参考姿态生成结果。

Defaultfalse
use_original_alpha?boolean
Defaultfalse
preview_render?boolean

可选,若为真,则在下载列表中提供一张额外的高质量渲染图像。默认值为 false。

Defaultfalse
mesh_simplify?boolean

可选。用于控制Raw网格是否被简化。此参数仅用于Gen1/1.5且mesh_mode为Raw时有效。

Defaulttrue
mesh_smooth?boolean

可选。用于控制生成的四边面网格是否进行平滑处理。此参数仅用于Gen1/1.5且mesh_mode为Quad时有效。

Defaultfalse

Response Body

application/json
  1. response
error?string
Value in"NO_SUCH_TASK""ASSET_NOT_AVAILABLE""IMAGE_LABEL_LENGTH_TOO_LONG""INVALID_REQUEST""API_NO_ACTIVE_SUBSCRIPTION""API_SUBSCRIPTION_PLAN_TOO_LOW""API_PARALLELISM_LIMIT_REACHED""API_INSUFFICIENT_FUNDS""API_OBJECT_NOT_FOUND_ON_IMAGE""IMAGE_CONTENT_VIOLATION""PERMISSION_DENIED""API_UNKNOWN"
message?string

成功消息或详细错误信息。

uuid?string

提交的生成任务的唯一标识符。

Formatuuid
submit_time?string

提交任务的服务器时间。

Formatdate-time
jobs?

一个包含生成过程中执行的各个任务详细信息的工作对象。

consumed?number

本次请求消耗的 credits。

prompt?string

实际用于生成的提示词。

Example Request
curl -X POST 'https://api.hyper3d.com/api/v2/rodin' \  -F 'tier=Sketch'
Example Response
{  "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"}

输入

从 Sketch、Regular、Detail 或 Smooth 中选择一个 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 可取 Quad 或 Raw,默认为 Quad。

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

    • Quad:high 50000、medium 18000、low 8000、extra-low 4000。
    • Raw:high 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 模式的 Sketch 和 Regular,显式设置不超过 100000 的 quality_override 时,还会请求面数约为该值 16 倍的高模。对于 Detail 和 Smooth,HighPack 只改变纹理分辨率。

计费

项目扣费
Gen-1/1.5 基础生成0.5 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 表示触发限流。