Sequences

Update a sequence

All fields are optional. Providing clips triggers full replacement of clipsJson and recomputes durationMs. Each clip's animationId is re-validated against the sprite.

patch/v1/sequences/{id}

Request

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

Path parameters

idstring required

Sequence ID

Request body

namestring

New name for the sequence

loopMode'forever' | 'once' | 'pingpong'

How the sequence loops: forever, once, or pingpong

metadataobject

Free-form metadata (tags, notes, etc.)

Example request

{
  "name": "renamed-sequence",
  "clips": [
    {
      "id": "c1",
      "animationId": "clx_abc123",
      "repeat": 2,
      "speedMultiplier": 1,
      "transitionOut": {
        "type": "cut",
        "durationMs": 200,
        "holdFrameIndex": 7
      }
    }
  ],
  "metadata": {
    "tags": [
      "combat",
      "boss"
    ]
  }
}

Response

Sequence updated

Changes

No recorded changes to this operation across all 1 revision of this API.