latestSwagger 2.02026-08-19218237253.7 KB

3af866d68651

Jobs

Enqueue a 3D model rigging job (Roles: user)

post/jobs/rig-model

Request body

request_idstring
model_asset_idstring

Parent 3D asset id whose model this rig replaces in place (image.id for generated, synthetic id for uploads). Ignored when as_new_asset is true.

user_modelstring

URL of a user-uploaded GLB to rig.

user_model_file_typestring
rig_type'general' | 'humanoid' | 'game' | 'humanoid_template' | 'humanoid_template_hands'

Which skeleton to build. general (default) lets the model choose; humanoid/game bias toward anime-style and classic game-character rigs. The humanoid_template options pin a standard humanoid skeleton with named joints — required for the animation preset library: humanoid_template (22 joints) or humanoid_template_hands (52, five fingers per hand). Only for two-armed, two-legged characters.

joint_naming'smpl' | 'mixamo' | 'humanik' | 'unreal' | 'godot' | 'rigify' | 'vroid'

Bone naming convention for the joints we can identify. Purely a relabel — the skeleton is identical. Joints outside the humanoid template keep their generic names.

render_videoboolean
as_new_assetboolean

Re-rig — save the rigged result as a new 3D asset entry instead of overwriting the source, preserving the original model and its saved animations.

Response

Accepted

jobIdstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
queue_positioninteger