Render Options - Viggle API

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. V4_Preview (default) or V3_Preview (legacy).

background_mode

string

default:"original"

Background handling mode.

Value	Description
`original`	Remove the person and AI-fill the background (default)
`solid`	Replace with solid color (use with `bg_color`)
`transparent`	Separate 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:"255,255,255"

RGB color for solid background. Only valid when background_mode=solid (rejected otherwise). Format: "R,G,B" (0-255). Examples: "255,255,255" (white), "0,0,0" (black), "0,255,0" (green scree

Examples

Default
Green Screen
Fast
Transparent

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"

Solid green background for chroma keying.

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" \
  -d "background_mode=solid" -d "bg_color=0,255,0"

Priority rendering when capacity is available.

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" \
  -d "fast=true"

Generates main video + mask video for compositing.

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" \
  -d "background_mode=transparent"

Background mode comparison

Mode	Use Case	Output
`original`	General use, keep scene context	Original background preserved
`solid`	Green screen, compositing	Solid color background
`transparent`	Professional compositing	Black bg video + separate mask video

Best practices

Background selection

Use original when you want scene context. Use solid or transparent when compositing in video editors.

Transparent mode and mask

Generates two outputs: main video (character on black) and mask video (white = character). Use both in your editor. See Compositing Guide.

Performance optimization

Enable fast mode for 2x rendering speed. Costs 2x credits. Requires a driving_video upload or scene_id.

Documentation Index

​Available options

​Examples

​Background mode comparison

​Best practices

Available options

Examples

Background mode comparison

Best practices