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

> Combine characters and scenes to generate animated videos

The Render API brings a character and a scene together into an animated video. The flow is simple: submit a render job, poll the status endpoint until it's done, then download your video from `cdn_url`.

## Job Status Flow

Jobs progress through the following statuses:

```mermaid theme={null}
graph LR
    A[queued] --> B[processing]
    B --> C[complete]
    B --> D[failed]
```

| Status       | Description                                                                                                                     |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `queued`     | Job is waiting in the queue                                                                                                     |
| `processing` | Pipeline is running (check `progress_pct` and `current_stage` for live stage; `checkpoint` reflects the last *completed* stage) |
| `complete`   | Video is ready -- use `cdn_url` to download                                                                                     |
| `failed`     | Job failed (check `error_code` and `error_message` fields)                                                                      |
| `cancelled`  | Job was cancelled                                                                                                               |

## Polling Example

```python theme={null}
import requests, time

API_KEY, BASE = "YOUR_API_KEY", "https://apis.viggle.ai"
headers = {"Authorization": f"Bearer {API_KEY}"}

# Create render job
job = requests.post(f"{BASE}/api/render", headers=headers, data={
    "character_id": "char_xxx",
    "scene_id": "scene_xxx",
}).json()

# Poll until complete (no auth required)
while True:
    status = requests.get(f"{BASE}/api/render/{job['job_id']}").json()
    print(f"Status: {status['status']} ({status.get('progress_pct', 0)}%)")
    if status["status"] == "complete":
        print(f"Video: {status['cdn_url']}")
        break
    elif status["status"] == "failed":
        raise Exception(f"{status.get('error_code')}: {status.get('error_message')}")
    time.sleep(3)

# Download
video = requests.get(status["cdn_url"])
open("output.mp4", "wb").write(video.content)
```

## Quick Links

<CardGroup cols={2}>
  <Card title="Create Render Job" icon="play" href="/api-reference/render/create">
    Start a single-character render
  </Card>

  <Card title="Get Job Status" icon="chart-column" href="/api-reference/render/status">
    Check render progress (no auth required)
  </Card>

  <Card title="On-Demand Guide" icon="zap" href="/guides/on-demand">
    Render without preprocessing -- one API call
  </Card>

  <Card title="Import Templates" icon="download" href="/guides/import-templates">
    Find and import pre-made scenes from viggle.ai
  </Card>
</CardGroup>