> ## Documentation Index
> Fetch the complete documentation index at: https://docs.viggle.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Render Options

> Configure video generation settings

Pass optional form fields when creating a render job via `POST /api/render`. All options have sensible defaults.

## Available options

<ParamField body="model" default="V3_Preview" type="string">
  Avatar model. `V3_Preview` (default) or `V4_Preview`.
</ParamField>

<ParamField body="background_mode" default="original" type="string">
  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`) |

  <Note>
    `inpaint` is accepted as an alias for `original` for backward compatibility.
  </Note>
</ParamField>

<ParamField body="bg_color" default="255,255,255" type="string">
  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
</ParamField>

## Examples

<Tabs>
  <Tab title="Default" icon="play">
    Original background, standard speed.

    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="Green Screen" icon="image">
    Solid green background for chroma keying.

    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="Transparent" icon="scissors">
    Generates main video + mask video for compositing.

    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

## 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

<AccordionGroup>
  <Accordion title="Background selection">
    Use **original** when you want scene context. Use **solid** or **transparent** when compositing in video editors.
  </Accordion>

  <Accordion title="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](/guides/compositing).
  </Accordion>
</AccordionGroup>