---
title: "Create a sequence for a sprite"
method: POST
path: "/v1/sprites/{spriteId}/sequences"
tags: ["Sequences"]
---

# Create a sequence for a sprite

`POST /v1/sprites/{spriteId}/sequences`

## Request

- Base URL: `https://api.sprixen.com`
- URL: `https://api.sprixen.com/v1/sprites/{spriteId}/sequences`
- Auth: `bearer` (a scheme the document does not define)

Creates a composed animation sequence by ordering existing animations into clips. No credits are charged — manual composition is free. Only animations belonging to the same sprite may be referenced.

## Path parameters

- `spriteId` string, required

## Request body

- CreateSequenceDto
  - `name` string, required: Human-readable name for the sequence
  - `loopMode` 'forever' | 'once' | 'pingpong': How the sequence loops: forever, once, or pingpong
  - `clips` SequenceClipDto[], required: Ordered list of clips that make up the sequence
    - `id` string, required: Local clip ID — stable across reorders (drag-drop key)
    - `animationId` string, required: ID of the Animation record this clip references
    - `repeat` number, required: How many times to repeat this clip. Use -1 for terminal infinite loop.
    - `speedMultiplier` number: Speed multiplier for this clip. Default 1.0.
    - `transitionOut` TransitionOutDto
      - `type` 'cut' | 'hold' | 'crossfade', required: Transition type: cut (instant), hold (freeze a frame), crossfade (opacity blend)
      - `durationMs` number: Duration in ms — required for hold and crossfade, ignored for cut
      - `holdFrameIndex` number: For hold: which frame index to freeze (default: last frame)
  - `metadata` object: Free-form metadata (tags, notes, etc.)

## Response `201`

Sequence created

## Other responses

- `400`: Invalid input or clip animation not found/mismatched
- `403`: Access denied to this sprite
- `404`: Sprite not found

---

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