LUludo
Jobs

Enqueue a 3D-to-sprite render: each view asked for (directions) as its own styled spritesheet, rendered together so they line up. The job's result is the list of sheets. One RENDER_SPRITE_3D charge per sheet (Roles: user).

Changed on
post/jobs/render-sprite-3d

Request

  • Base URL
    https://api.ludo.ai/api
  • Auth
    API key in header Authorization

Request body

request_idstring
user_modelstring

URL of an uploaded GLB (rigged, to animate it). Provide this OR generated_model.

user_model_file_type'glb'
animation_clip_idstring

One of the model's saved animations (an Animation3DClip id) to render.

preset_idstring

An animation preset (/utils/animation-presets) the ML retargets onto the rigged model and renders.

crop_loopboolean

With preset_id, trim the preset to the span that loops seamlessly. Omit to follow the preset's own loop flag.

model_animationstring

Name of an animation the model file itself carries. With no animation at all the model renders as a still.

perspective'horizon' | 'low' | 'isometric' | 'high' | 'top' required
directionsstring[]

Where the camera stands around a character facing S, each view at most once. One result per view, in this order, rendered together on the same frame, scale and floor, so the views line up.

direction'S' | 'SW' | 'W' | 'NW' | 'N' | 'NE' | 'E' | 'SE'

Deprecated: one view. Use directions.

style_idstring required

id of a style from /utils/sprite3d-styles

style_versioninteger

Version of the style; omit for its current one.

style_paramsobject

Overrides of the style's settings, by name, each one of its listed choices (or true/false, or a colour for a colour setting).

keep_horizontal_travelboolean

Keep the animation's ground travel (the character moves across the frame). Off by default.

keep_vertical_travelboolean

Keep the animation's vertical root motion (jumps, bobbing). On by default.

target_frame_sizeinteger

Sprite size in px (the frame's longer side); default 256.

num_framesinteger

Frames per sheet, sampled over the clip (fewer when the clip has fewer keyframes; a still gives one). Default 16.

loopboolean

Sample the clip as a seamless loop. Omit to follow the animation's own loop flag.

Response

Accepted

jobIdstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
queue_positioninteger

Changes