animate_object
Animates a saved pixel art object by ID, with v3 mode for higher quality and custom start/end frame interpolation, or pro mode. Supports 1-direction and 8-direction objects.
Instructions
Animate a SAVED object by ID. mode='v3' (default, higher quality, supports custom_start_frame/end_frame interpolation) or 'pro'. Do NOT pass directions for 1-direction objects; for 8-direction objects pass the directions to animate. Requires an object_id from create_object_1dir/8dir.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Animation mode (default 'v3') | |
| end_frame | No | Optional target pose to interpolate toward (v3 mode only) | |
| object_id | Yes | ID of the object to animate | |
| directions | No | Directions to animate (8-direction objects only; omit for 1-direction objects) | |
| frame_count | No | Frames per direction | |
| display_name | No | Optional name for the animation | |
| enhance_prompt | No | Auto-expand the description into a richer prompt before generating (default false) | |
| replace_existing | No | Regenerate a direction already animated in this animation (default false) | |
| animation_group_id | No | For 8-direction objects: animation_group_id of an existing animation to add directions to | |
| custom_start_frame | No | Optional custom starting pose (v3 mode only) | |
| animation_description | No | Describe the animation, e.g. 'walking cheerfully' (required for a new animation, max 1000 chars) |