Animate

Generate animation using skeletons

Changed on Sep 1, 2026

Creates a pixel art animation based on the provided parameters. Called "Animate with skeleton" in the plugin.

Supported image sizes:

16x16
32x32
64x64
128x128
256x256

Supported features:

Inpainting
Init image
Forced palette

Using the Python client:

import pixellab

client = pixellab.Client(secret="YOUR_API_TOKEN")

response = client.animate_with_skeleton(
    view="side",
    direction="south",
    image_size=dict(width=64, height=64),
    reference_image=reference_image,
    inpainting_images=existing_animation_frames,
    mask_images=mask_images,
    skeleton_keypoints=skeleton_keypoints,
)
images = [image.pil_image() for image in response.images]

post/animate-with-skeleton

Request

Base URL
https://api.pixellab.ai/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/pixellab/apis/pixel-lab-api/docs/animate-with-skeleton/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

guidance_scalenumber

How closely to follow the reference image and skeleton keypoints

view'side' | 'low top-down' | 'high top-down'

isometricboolean

Generate in isometric view

oblique_projectionboolean

Generate in oblique projection

init_image_strengthinteger

Strength of the initial image influence

seedinteger nullable

Seed decides the starting noise

Example request

{
  "image_size": {
    "height": 64,
    "width": 64
  }
}

Response

Successfully generated image

Changes

Sep 1, 2026eb7a18b195ba Revision changes
- breaking
  added the new required request property /
- breaking
  request property was restricted to a list of enum values
- breaking
  request property was restricted to a list of enum values
- breaking
  the request property type changed from no type to string
- breaking
  the / request property type changed from object to no type
- breaking
  the / request property type changed from object to no type
- breaking
  the request property type changed from no type to object
- breaking
  the /// request property type changed from number to integer
- breaking
  the request property type changed from no type to string
- breaking
  the response property / became optional for the status
- breaking
  response property usage/usd list-of-types was widened by adding types null to media type application/json of response 200
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed from the request property allOf list
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  added the new generations enum value to the / response property for the response status
- info
  added the new optional request property /
- info
  added subschema #2 to the request property anyOf list
- info
  added subschema #2 to the / request property anyOf list
- info
  added subschema #2 to the / request property anyOf list
- info
  added the new east enum value to the request property
- info
  added the new high top-down enum value to the request property
- info
  added the new low top-down enum value to the request property
- info
  added the new north enum value to the request property
- info
  added the new north-east enum value to the request property
- info
  added the new north-west enum value to the request property
- info
  added the new side enum value to the request property
- info
  added the new south enum value to the request property
- info
  added the new south-east enum value to the request property
- info
  added the new south-west enum value to the request property
- info
  added the new west enum value to the request property
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  the / request property's max was increased from 200.00 to 256.00
- info
  the / request property's max was increased from 200.00 to 256.00
- info
  added the optional property / to the response with the status
- info
  the response property const value base64 was added for the status
- info
  removed the base64 enum value from the // response property for the response status

Operation history