Character Studio 3D

Render an 8-direction sprite sheet of a completed character

Cost: 4 credits per animation type (refunded on technical failure). Creates a Sprite (frame 0 of "down") with 8 Animation rows, one per direction. Poll GET /character-studio/sprite-renders/:id.

post/v1/character-studio/characters/{id}/sprite-sheet

Request

  • Base URL: https://api.sprixen.com
  • URL: https://api.sprixen.com/v1/character-studio/characters/{id}/sprite-sheet
  • Auth: bearer (a scheme the document does not define)

Path parameters

idstring required

Completed character (3D model) ID

Request body

animationType'idle' | 'walk' | 'run' | 'attack' | 'jump' | 'death' | 'hurt' required

Sprixen animation type to render. Mapped to the base character action. Produces 8 directions (down, down-left, left, up-left, up, up-right, right, down-right).

framesnumber

Frames per direction, 1 to 16. Default 8.

sizenumber

Frame size in pixels (square), 64 to 256. Default 128. Downscale or pixelate on your side for smaller sprites.

elevationnumber

Camera elevation in degrees, 0 (side) to 60 (top-down tilt). Default 30.

projectIdstring

Project that receives the generated Sprite. Defaults to the model project, then to your first project.

Example request

{
  "animationType": "walk",
  "projectId": "cld1234..."
}

Response

Render queued (pending)

Changes

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