Create animation
create_animationAnimates a pose, or the mascot itself, into a short silent MP4 clip (5 credits; requires that the account has bought credits at least once). The clip can be pinned at both ends with end_pose_id, or looped so it ends where it began. Returns a generation_id; animations take one to three minutes, so call check_generation with wait_seconds 50 and repeat until it settles.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| loop | No | Finish on the opening frame so the clip repeats with no visible cut. Wins over end_pose_id when both are set. | |
| motion | Yes | What the character does in the clip, e.g. 'waves at the camera, blinking happily'. | |
| pose_id | No | Optional pose id to animate. Wins over mascot_id when both are set. | |
| mascot_id | No | Optional mascot id to animate directly from its front view. With neither this nor pose_id, the project's newest mascot is animated, so pass one of them whenever the project has more than one character. | |
| end_pose_id | No | Optional pose id the clip must finish on, instead of ending wherever the motion drifts. Any pose in the project: ending on a different character interpolates one into the other, which is a morph rather than a mistake. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| note | No | ||
| status | Yes | ||
| target | No | ||
| expected | No | ||
| next_step | No | ||
| cost_charged | No | ||
| generation_id | Yes |