S
spritesynthDOCS

Animate with Text

Generate animation from a reference image and text description.

Animate with Text

Generate animations from a static character sprite and a text description. The model creates a full animation sequence based on the requested animation type.

Endpoints

VersionEndpoint
v1POST /api/animations/animate-with-text
v2POST /api/animations/animate-with-text-v2
v3POST /api/animations/animate-with-text-v3

Parameters

NameTypeRequiredDescription
characterstringYesCharacter image URL or base64-encoded image
descriptionstringYesText description of the animation
animation_typestringYesType of animation: idle, walk, run, attack, hurt, death, cast, jump

Example

curl -X POST https://api.spritesynth.com/api/animations/animate-with-text-v3 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "character": "https://example.com/character.png",
    "description": "a warrior swinging a sword with force",
    "animation_type": "attack"
  }'

Response

{
  "id": "anim_123",
  "status": "completed",
  "animation": {
    "url": "https://cdn.spritesynth.com/animations/anim_123.gif",
    "sprite_sheet": "https://cdn.spritesynth.com/animations/anim_123_sheet.png",
    "frame_count": 8,
    "frame_width": 64,
    "frame_height": 64,
    "fps": 12
  },
  "credits_cost": 3,
  "duration_ms": 5200
}

Tips

  • Use v3 for the latest quality improvements.
  • Keep character sprites clean — remove backgrounds before animating.
  • walk and idle produce the most reliable results.

Need help?

Join our Discord community for support and tips.
Was this page helpful?

On this page