Rodin Generation
This API will generate a mesh and textures for the given images and prompt.
concat
可能的值: glb
可能的值: PBR
可能的值: medium
可能的值: false
Quad
可能的值: true
true
curl https://api.hyper3d.com/api/v2/rodin \
--request POST \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--file 'images=@/path/to/your/image.png' \
--file "tier=Regular" \
...
{
"error": "text",
"message": "text",
"uuid": "text",
"jobs": {
"uuids": [
"text"
],
"subscription_key": "text"
}
}
Rodin生成
使用此API向我们的服务器提交异步任务。你将从API中获得一个任务UUID,该UUID可用于检查进度和下载结果。
价格
Base Cost: `
Sketch`
和`Regular`
每次生成消耗 0.5 Credit。Addons:
HighPack
: 每次生成额外消耗 1 Credit。
请求
Authentication
此API使用密钥进行身份验证。您需要在所有请求的Authorization
头中包含一个有效的密钥. 参阅快速开始获取您的账户的API生成密钥。
Authorization: Bearer RODIN_API_KEY
Body
images
file/Binary
用于图像生成,最多上传5张图片。由于form-data请求将保留图像的顺序,因此将会使用上传列表的第一张图片来生成材质贴图。 对于Image-to-3D模式,图片是必须的。可上传一张或多张图片。(最多上传5张图片。) 对于Text-to-3D模式,则不需要上传图片。
prompt
string
用于指导模型生成的文本提示。 对于Image-to-3D生成模式是可选的。(如果没有提供,将使用基于提供的图像的人工智能生成的提示。) 对Text-to-3D模式是必须的。
condition_mode
string
该参数仅用于多图像生成。
这是一个可选的参数,用于选择多图生成时的生成方式。可能的值为fuse
或concat
。默认值为concat
。
对于fuse
模式,需要上传一张或多张图片。可以融合多张图片的物体特征生成一个模型。
对于concat
模式,需要上传同一物体的多张多视角图片,并生成该模型。(无须在意上传图片的顺序。)
seed
number
可选的。网格生成中用于随机化的种子值,范围从0到65535(包括两者)。如果不提供,种子将随机生成。
geometry_file_format
string
可选的。模型文件的格式。可能的值为glb
,usdz
,fbx
,obj
,stl
。默认值为glb
。
material
string
可选的。材质类型。可能的值为PBR
,Shaded
和All
。默认值为PBR
。
PBR
:物理基础材质,包括基础颜色纹理、金属度纹理、法线纹理和粗糙度纹理,提供高真实感并在动态光照下具有物理准确性。
Shaded
:仅包含基础颜色纹理和烘焙光照,提供风格化的视觉效果。
All
:会同时生成PBR
和Shaded
材质。
quality
string
可选的。生成质量。可能的值为high(50k面)
, medium(18k面)
, low(8k面)
, 和extra-low(4k面)
。默认值为medium
。
对于Rodin Sketch,该值仅为medium
时生效。
quality_override
number
可选的。自定义生成模型的面数。范围从1000到200000面,可对网格面数提供更精确的控制。
该参数为quality
参数的进阶参数。当调用该参数时,quality
参数不会生效。
对于Rodin Sketch,该参数不会生效,模型面数设置为quality
参数的默认值。
tier
string
可选的。默认值为Regular
。
Sketch:快速生成,细节较少,适合概念草图或初步构思。
Regular:兼顾速度与质量的生成,适用于大多数场景(默认选项)。
Detail:比 Regular 更丰富的细节表现,适合复杂需求(生成时间更长)。
Smooth:比 Regular 更清晰锐利的输出效果,生成时间略长。
TAPose
bool
可选的。控制生成类人模型时,生成结果展现为T/A Pose。
当该值为true
时,生成的模型将为Tpose或者Apose。
bbox_condition
Array of Integer
可选的。该参数是一个控制生成模型最大生成边界的control net. 通常来说,这个数组包含三个元素,分别是宽度(y轴),高度(z轴)和长度(x轴)。
mesh_mode
string
可选的,可选的值有Raw
和Quad
. 默认值为Quad
.
Raw
模式会生成三角面模型。
Quad
模式生成四边面模型。
当tier
为Sketch
:仅生成三角面。
mesh_simplify
bool
可选的。当值为true
时,将会生成简化模型。
该参数仅当mesh_mode的值为Raw
时生效。
mesh_smooth
bool
可选的。当值为true
时,将会生成平滑模型(效果等同于Rodin Gen-1)。
该参数仅当mesh_mode的值为Quad
时生效。
addons
array of strings
可选的。生成附加功能。默认为[]
。可能的值为HighPack
.
HighPack
选项会提供4K分辨率的纹理贴图而不是基础的2K分辨率,同时还会提供更高面数的模型文件。(约16倍选择quality对应面数。)
响应
error
string
错误信息(如有)
message
string
成功信息或详细的错误信息。
uuid
string
生成任务的唯一标识符。
jobs
object
一个作业对象,包含作为生成过程一部分执行的各个作业的详细信息。
jobs.uuids
array of strings
子任务的UUIDs。
jobs.subscription_key
string
任务密钥
代码示例
Minimal Rodin Regular Generation(Image-to-3D)
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F "images=@/path/to/your/image.jpg"
unset RODIN_API_KEY
Minimal Rodin Sketch Generation(Image-to-3D)
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F "images=@/path/to/your/image.jpg" \
-F "tier=Sketch"
unset RODIN_API_KEY
Minimal Rodin Generation(Text-to-3D)
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F "prompt=A 3D model of a futuristic robot" \
unset RODIN_API_KEY
Minimal Rodin Generation(Image-to-3D with multi-view images)
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F 'condition_mode=concat' \
-F "images=@/path/to/your/image_0.jpg" \
-F "images=@/path/to/your/image_1.jpg"
unset RODIN_API_KEY
Minimal Rodin ControlNet Generation(Bounding Box Condition)
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F "bbox_condition=[100,100,100]"
-F "prompt=A sofa."
unset RODIN_API_KEY
Comprehensive Rodin Regular Generation with All Parameters
export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/rodin \
-H "Authorization: Bearer ${RODIN_API_KEY}" \
-F "images=@/path/to/your/image.jpg" \
-F "prompt=A 3D model of a futuristic robot" \
-F "seed=42" \
-F "geometry_file_format=fbx" \
-F "material=PBR" \
-F "quality=high" \
-F "use_hyper=true" \
-F "tier=Regular" \
-F "addons=HighPack"
unset RODIN_API_KEY
最后更新于
这有帮助吗?