Skip to main content
Pass optional form fields when creating a render job via POST /api/render. All options have sensible defaults.

​
Available options

​
model
string
default:"V4_Preview"
Avatar model for rendering. Only applies to on-demand renders (when uploading ref_image + driving_video directly).
ValueDescription
V4_PreviewDefault model (default)
V3_PreviewAlternative avatar model with a dedicated GPU pool
Preprocessed renders: When using character_id + scene_id, the model is automatically determined by the scene’s preprocessing model. Do not pass model — it will be ignored or rejected if it conflicts with the scene.To use V3 with preprocessed assets, pass model=V3_Preview when creating the scene via POST /api/scenes/preprocess. All renders using that scene will automatically use V3.
​
background_mode
string
default:"original"
Background handling mode.
ValueDescription
originalRemove the person and AI-fill the background (default)
solidReplace with solid color (use with bg_color)
transparentSeparate mask video for compositing (returns mask_cdn_url alongside cdn_url)
inpaint is accepted as an alias for original for backward compatibility.
​
bg_color
string
default:"0,255,0"
RGB string for solid background. Only used when background_mode is solid. Format: "R,G,B" (0-255, not hex).
​
fast
boolean
default:"false"
Enable fast mode for 2x rendering speed at 2x credit cost. Requires a driving_video upload or a scene_id.
Fast mode requires available capacity. Returns 400 with CS-UORC01-001 if unavailable — retry with fast=false or wait.

​
Examples

Original background, standard speed.
curl -X POST "https://apis.viggle.ai/api/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d "character_id=char_xxx" -d "scene_id=scene_xxx"

​
Background mode comparison

ModeUse CaseOutput
originalGeneral use, keep scene contextOriginal background preserved
solidGreen screen, compositingSolid color background
transparentProfessional compositingBlack bg video + separate mask video

​
Best practices

Use original when you want scene context. Use solid or transparent when compositing in video editors.
Generates two outputs: main video (character on black) and mask video (white = character). Use both in your editor. See Compositing Guide.
Enable fast mode for 2x rendering speed. Costs 2x credits. Requires a driving_video upload or scene_id.