---
title: "Enqueue a spritesheet-edit job (Roles: user)"
method: POST
path: "/jobs/generate-edit-spritesheet"
tags: ["Jobs"]
---

# Enqueue a spritesheet-edit job (Roles: user)

`POST /jobs/generate-edit-spritesheet`

## Request body

- EditSpritesheetPayload — Payload for editing a spritesheet's video. edit_mode selects the operation - prompt-driven edit (default), outpaint, or loop fixing.
  - `request_id` string
  - `edit_mode` 'prompt' | 'outpaint' | 'fix_loop' — Edit operation to perform.
  - `prompt` string — Edit instruction. Required for edit_mode "prompt", optional for "outpaint", not accepted for "fix_loop".
  - `spritesheet` Spritesheet, required
    - `tags` string[]
    - `id` string
    - `audio_b64` string
    - `duration` number, float
    - `start_timestamp` number
    - `end_timestamp` number
    - `num_frames` number
    - `num_cols` number — Columns in the frame grid. Absent on legacy sheets, which use a square grid of ceil(sqrt(num_frames)) per side.
    - `num_rows` number — Rows in the frame grid. Absent on legacy sheets, which use a square grid of ceil(sqrt(num_frames)) per side.
    - `max_num_frames` number
    - `margin_ratio` number
    - `margin_ratio_horizontal` number, float
    - `margin_ratio_vertical` number, float
    - `margin_ratio_mode` string
    - `target_frame_size` number
    - `loop` boolean
    - `bad_loop` boolean
    - `out_of_frame` boolean
    - `crop` boolean
    - `original_prompt` string
    - `motion_prompt` string
    - `prompt` string
    - `seed` number
    - `sprite_sheet` PILImage
      - `format` string
      - `format_description` string
    - `sprite_sheet_b64` string
    - `sprite_sheet_raw_b64` string
    - `sprite_sheet_watermarked_b64` string — URL of the watermarked variant of sprite_sheet_b64 (object key = clean key + "_wm"). Present only when generated by a free user; served IN PLACE of sprite_sheet_b64 to free viewers. sprite_sheet_b64 itself always stays the clean asset.
    - `sprite_sheet_raw_watermarked_b64` string — Watermarked variant of sprite_sheet_raw_b64 (see sprite_sheet_watermarked_b64).
    - `watermarked` boolean — Response-only. True when the served sprite_sheet_b64 is the watermarked variant (free viewer). Never persisted - stripped from inbound bodies.
    - `video` GeneratedVideo
      - `tags` string[]
      - `id` string
      - `original_prompt` string
      - `prompt` string
      - `url` string
      - `image` GameImage
        - `tags` string[]
        - `id` string
        - `image_id` string
        - `url` string
        - `type` string
        - `final_score` number, float
        - `nsfw_prob` number, float
        - `similarity` number, float
        - `width` integer
        - `height` integer
        - `game_id` string
        - `hosted_filename` string
        - `icon` boolean
        - `targetSize` integer
        - `seed` integer
        - `embedded` boolean
        - `analysed` boolean
        - `image` string
        - `image_type` string
        - `prompt` string
        - `motion_prompt` string
        - `request_id` string
        - `hints` string[]
        - `selected_genres` string[]
        - `selected_colors` string[]
        - `selected_style` string
        - `selected_perspective` string
        - `is_safe` boolean
        - `platform` string
        - `loading` boolean
        - `original_hints` string[]
        - `genres` string[]
        - `edit_mask` string
        - `edit_mode` string
        - `camera_rotation` integer
        - `camera_elevation` integer
        - `edit_mask_pil_image` PILImage
          - `format` string
          - `format_description` string
        - `pil_image` PILImage
          - `format` string
          - `format_description` string
        - `nsfw` number, float
        - `pose` SpritePose
          - `animation_prompt` string — Animation description for the sprite pose
          - `margin_ratio` number, float — Margin ratio for the sprite animation
          - `margin_ratio_mode` string
          - `name` string — Name of the sprite pose
          - `prompt` string — Prompt description for the sprite pose
      - `pil_image` PILImage
        - `format` string
        - `format_description` string
      - `seed` integer
      - `duration` number, float
      - `has_audio` boolean
      - `model` string — Codename of the model that generated the video, e.g. eagle. Absent on videos created before it was recorded.
      - `pixel_grid` integer[], nullable — Pixel-art grid dimensions [width, height] detected/used by the generation, or null. Reported by pixel-art-aware models (forge-pixel); must always be persisted with the video.
      - `reference_url` string — Motion clip the animation was driven by (motion transfer presets), as reported by the ML. Absent on videos saved before it was recorded.
      - `crop_and_center_image` boolean
      - `middle_image` GameImage
        - `tags` string[]
        - `id` string
        - `image_id` string
        - `url` string
        - `type` string
        - `final_score` number, float
        - `nsfw_prob` number, float
        - `similarity` number, float
        - `width` integer
        - `height` integer
        - `game_id` string
        - `hosted_filename` string
        - `icon` boolean
        - `targetSize` integer
        - `seed` integer
        - `embedded` boolean
        - `analysed` boolean
        - `image` string
        - `image_type` string
        - `prompt` string
        - `motion_prompt` string
        - `request_id` string
        - `hints` string[]
        - `selected_genres` string[]
        - `selected_colors` string[]
        - `selected_style` string
        - `selected_perspective` string
        - `is_safe` boolean
        - `platform` string
        - `loading` boolean
        - `original_hints` string[]
        - `genres` string[]
        - `edit_mask` string
        - `edit_mode` string
        - `camera_rotation` integer
        - `camera_elevation` integer
        - `edit_mask_pil_image` PILImage
          - `format` string
          - `format_description` string
        - `pil_image` PILImage
          - `format` string
          - `format_description` string
        - `nsfw` number, float
        - `pose` SpritePose
          - `animation_prompt` string — Animation description for the sprite pose
          - `margin_ratio` number, float — Margin ratio for the sprite animation
          - `margin_ratio_mode` string
          - `name` string — Name of the sprite pose
          - `prompt` string — Prompt description for the sprite pose
      - `final_image` GameImage
        - `tags` string[]
        - `id` string
        - `image_id` string
        - `url` string
        - `type` string
        - `final_score` number, float
        - `nsfw_prob` number, float
        - `similarity` number, float
        - `width` integer
        - `height` integer
        - `game_id` string
        - `hosted_filename` string
        - `icon` boolean
        - `targetSize` integer
        - `seed` integer
        - `embedded` boolean
        - `analysed` boolean
        - `image` string
        - `image_type` string
        - `prompt` string
        - `motion_prompt` string
        - `request_id` string
        - `hints` string[]
        - `selected_genres` string[]
        - `selected_colors` string[]
        - `selected_style` string
        - `selected_perspective` string
        - `is_safe` boolean
        - `platform` string
        - `loading` boolean
        - `original_hints` string[]
        - `genres` string[]
        - `edit_mask` string
        - `edit_mode` string
        - `camera_rotation` integer
        - `camera_elevation` integer
        - `edit_mask_pil_image` PILImage
          - `format` string
          - `format_description` string
        - `pil_image` PILImage
          - `format` string
          - `format_description` string
        - `nsfw` number, float
        - `pose` SpritePose
          - `animation_prompt` string — Animation description for the sprite pose
          - `margin_ratio` number, float — Margin ratio for the sprite animation
          - `margin_ratio_mode` string
          - `name` string — Name of the sprite pose
          - `prompt` string — Prompt description for the sprite pose
      - `margin_ratio` number, float
      - `margin_ratio_horizontal` number, float
      - `margin_ratio_vertical` number, float
    - `preview_video_b64` string
    - `first_frame_b64` string
    - `last_frame_b64` string
    - `image` GameImage
      - `tags` string[]
      - `id` string
      - `image_id` string
      - `url` string
      - `type` string
      - `final_score` number, float
      - `nsfw_prob` number, float
      - `similarity` number, float
      - `width` integer
      - `height` integer
      - `game_id` string
      - `hosted_filename` string
      - `icon` boolean
      - `targetSize` integer
      - `seed` integer
      - `embedded` boolean
      - `analysed` boolean
      - `image` string
      - `image_type` string
      - `prompt` string
      - `motion_prompt` string
      - `request_id` string
      - `hints` string[]
      - `selected_genres` string[]
      - `selected_colors` string[]
      - `selected_style` string
      - `selected_perspective` string
      - `is_safe` boolean
      - `platform` string
      - `loading` boolean
      - `original_hints` string[]
      - `genres` string[]
      - `edit_mask` string
      - `edit_mode` string
      - `camera_rotation` integer
      - `camera_elevation` integer
      - `edit_mask_pil_image` PILImage
        - `format` string
        - `format_description` string
      - `pil_image` PILImage
        - `format` string
        - `format_description` string
      - `nsfw` number, float
      - `pose` SpritePose
        - `animation_prompt` string — Animation description for the sprite pose
        - `margin_ratio` number, float — Margin ratio for the sprite animation
        - `margin_ratio_mode` string
        - `name` string — Name of the sprite pose
        - `prompt` string — Prompt description for the sprite pose
    - `middle_image` GameImage
      - `tags` string[]
      - `id` string
      - `image_id` string
      - `url` string
      - `type` string
      - `final_score` number, float
      - `nsfw_prob` number, float
      - `similarity` number, float
      - `width` integer
      - `height` integer
      - `game_id` string
      - `hosted_filename` string
      - `icon` boolean
      - `targetSize` integer
      - `seed` integer
      - `embedded` boolean
      - `analysed` boolean
      - `image` string
      - `image_type` string
      - `prompt` string
      - `motion_prompt` string
      - `request_id` string
      - `hints` string[]
      - `selected_genres` string[]
      - `selected_colors` string[]
      - `selected_style` string
      - `selected_perspective` string
      - `is_safe` boolean
      - `platform` string
      - `loading` boolean
      - `original_hints` string[]
      - `genres` string[]
      - `edit_mask` string
      - `edit_mode` string
      - `camera_rotation` integer
      - `camera_elevation` integer
      - `edit_mask_pil_image` PILImage
        - `format` string
        - `format_description` string
      - `pil_image` PILImage
        - `format` string
        - `format_description` string
      - `nsfw` number, float
      - `pose` SpritePose
        - `animation_prompt` string — Animation description for the sprite pose
        - `margin_ratio` number, float — Margin ratio for the sprite animation
        - `margin_ratio_mode` string
        - `name` string — Name of the sprite pose
        - `prompt` string — Prompt description for the sprite pose
    - `final_image` GameImage
      - `tags` string[]
      - `id` string
      - `image_id` string
      - `url` string
      - `type` string
      - `final_score` number, float
      - `nsfw_prob` number, float
      - `similarity` number, float
      - `width` integer
      - `height` integer
      - `game_id` string
      - `hosted_filename` string
      - `icon` boolean
      - `targetSize` integer
      - `seed` integer
      - `embedded` boolean
      - `analysed` boolean
      - `image` string
      - `image_type` string
      - `prompt` string
      - `motion_prompt` string
      - `request_id` string
      - `hints` string[]
      - `selected_genres` string[]
      - `selected_colors` string[]
      - `selected_style` string
      - `selected_perspective` string
      - `is_safe` boolean
      - `platform` string
      - `loading` boolean
      - `original_hints` string[]
      - `genres` string[]
      - `edit_mask` string
      - `edit_mode` string
      - `camera_rotation` integer
      - `camera_elevation` integer
      - `edit_mask_pil_image` PILImage
        - `format` string
        - `format_description` string
      - `pil_image` PILImage
        - `format` string
        - `format_description` string
      - `nsfw` number, float
      - `pose` SpritePose
        - `animation_prompt` string — Animation description for the sprite pose
        - `margin_ratio` number, float — Margin ratio for the sprite animation
        - `margin_ratio_mode` string
        - `name` string — Name of the sprite pose
        - `prompt` string — Prompt description for the sprite pose
    - `has_audio` boolean
    - `model` string — Codename of the model that generated (or last re-rendered) the animation, e.g. blitz, forge, tango. Absent on sheets created before it was recorded.
    - `is_edited` boolean — True when this spritesheet was produced by an edit (prompt, outpaint, or fix_loop) - the whole animation was re-rendered, so frames may drift from the original.
    - `generation_mode` string — How the ML produced the animation, as reported by it (e.g. image, edit, motion_transfer). Absent on sheets saved before it was recorded.
    - `pixel_art_filter` string — Pixel-art filter the ML applied, as reported by it. Absent on sheets saved before it was recorded.
    - `label` string
    - `preview_scale` number, float
    - `pack_alignment` PackAlignment
      - `description` string
      - `sizeHeightPx` number, float
      - `groundOffset` number, float
      - `horizontalOffset` number, float
  - `images` GameImage[]
    - `tags` string[]
    - `id` string
    - `image_id` string
    - `url` string
    - `type` string
    - `final_score` number, float
    - `nsfw_prob` number, float
    - `similarity` number, float
    - `width` integer
    - `height` integer
    - `game_id` string
    - `hosted_filename` string
    - `icon` boolean
    - `targetSize` integer
    - `seed` integer
    - `embedded` boolean
    - `analysed` boolean
    - `image` string
    - `image_type` string
    - `prompt` string
    - `motion_prompt` string
    - `request_id` string
    - `hints` string[]
    - `selected_genres` string[]
    - `selected_colors` string[]
    - `selected_style` string
    - `selected_perspective` string
    - `is_safe` boolean
    - `platform` string
    - `loading` boolean
    - `original_hints` string[]
    - `genres` string[]
    - `edit_mask` string
    - `edit_mode` string
    - `camera_rotation` integer
    - `camera_elevation` integer
    - `edit_mask_pil_image` PILImage
      - `format` string
      - `format_description` string
    - `pil_image` PILImage
      - `format` string
      - `format_description` string
    - `nsfw` number, float
    - `pose` SpritePose
      - `animation_prompt` string — Animation description for the sprite pose
      - `margin_ratio` number, float — Margin ratio for the sprite animation
      - `margin_ratio_mode` string
      - `name` string — Name of the sprite pose
      - `prompt` string — Prompt description for the sprite pose
  - `duration` number, float
  - `model` 'hydra' | 'forge' | 'forge-pixel' — Backing model.
  - `crop` boolean
  - `loop` boolean
  - `num_frames` number
  - `target_frame_size` number
  - `spritesheet_with_background` boolean

## Response `202`

Accepted

- JobAcceptedResponse
  - `jobId` string, required
  - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
  - `queue_position` integer

## Other responses

- `400` — Error
- `402` — Insufficient credits

---

[API](https://skmtc.dev/ludo/apis/ludo-ai-api.md) · [All operations](https://skmtc.dev/ludo/apis/ludo-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ludo/apis/ludo-ai-api/revisions/a6d8dcc39b12?raw)