3D Studio

Create an animation for a 3D model

Dispatches async job: auto-rig (UniRig) → motion generation (HY-Motion) → retarget (Blender). Cost: 3 credits. Poll GET /animations-3d/:animId for status.

post/v1/models-3d/{id}/animations

Request

  • Base URL: https://api.sprixen.com
  • URL: https://api.sprixen.com/v1/models-3d/{id}/animations
  • Auth: bearer (a scheme the document does not define)

Path parameters

idstring required

Model3D ID (must be completed)

Request body

promptstring required

Text prompt describing the desired animation motion

presetSlugstring

Preset slug (walk, run, idle, attack, etc.). When set, the prompt is auto-filled from the preset library.

namestring

Human-readable name for the animation. Defaults to the preset label or a truncated prompt.

animationType'auto' | 'humanoid' | 'non_humanoid'

Animation pipeline to use. "auto" (default) lets the system detect via rigging. "humanoid" forces skeletal animation (HY-Motion). "non_humanoid" forces vertex deformation (AnimateAnyMesh).

Example request

{
  "prompt": "A person walking forward at a normal pace with natural arm swing",
  "presetSlug": "walk",
  "name": "Walk Cycle",
  "animationType": "auto"
}

Response

Animation job created (pending)

Changes

No recorded changes to this operation across all 1 revision of this API.