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

# Platform Overview

> Hosted infrastructure for asset generation, cloud rendering, and billing

Everything is Apache 2.0 and self-hostable. The hosted platform at `api.oanim.dev` provides managed infrastructure so you don't have to run your own.

## Platform services

<CardGroup cols={2}>
  <Card title="Console" icon="browser" href="/platform/console">
    Web dashboard at [oanim.dev](https://oanim.dev) for generating media, managing API keys, tracking usage, and purchasing credits.
  </Card>

  <Card title="Media Gateway" icon="images">
    Multi-provider AI image generation. Currently backed by fal.ai with Runway and other providers planned. Handles routing, cost metering, and usage tracking.
  </Card>

  <Card title="Cloud Rendering" icon="cloud">
    `oanim render --cloud` sends your composition to hosted infrastructure (Remotion Lambda) and streams back the rendered MP4. No local Chromium or ffmpeg needed.
  </Card>

  <Card title="Authentication" icon="lock">
    Browser-based OAuth via `oanim login`. API keys (prefixed `anim_`) for CI/CD and programmatic access.
  </Card>

  <Card title="Usage & Billing" icon="chart-bar">
    Pay-as-you-go credits with per-operation cost tracking. New accounts start with $5.00 in credits. Purchase more via Stripe with a 10% bonus on purchases over $50.
  </Card>
</CardGroup>

## How it connects

```
oanim CLI → api.oanim.dev → fal.ai (media generation)
                           → S3 + Remotion Lambda (cloud rendering)
                           → PostgreSQL (usage tracking)
                           → Stripe (billing)
```

## Authentication chain

Credentials resolve in this order:

1. `ANIMATE_API_KEY` environment variable
2. `~/.oanim/credentials.yaml` (saved by `oanim login`)
3. Direct provider key (`ANIMATE_FAL_KEY`) — bypasses platform, goes direct to fal.ai

## Rate limits

| Endpoint                              | Limit                       |
| ------------------------------------- | --------------------------- |
| Media gateway (`/api/v1/media/*`)     | 60 requests/minute per user |
| Auth endpoints (`/api/v1/auth/cli/*`) | 10 requests/minute per IP   |

## Free vs Hosted

| Feature                               | Self-hosted               | Hosted platform         |
| ------------------------------------- | ------------------------- | ----------------------- |
| `@oanim/core` library                 | Yes                       | Yes                     |
| `oanim init` / `oanim render` (local) | Yes                       | Yes                     |
| AI asset generation                   | Bring your own fal.ai key | Pay-per-use via credits |
| Cloud rendering                       | Run your own infra        | `oanim render --cloud`  |
| Usage tracking                        | N/A                       | Built-in dashboard      |
| API keys                              | N/A                       | Create & manage via CLI |

## Getting started

```bash theme={null}
# Sign in
oanim login

# Check your balance ($5.00 free credits on signup)
oanim usage

# Purchase credits
oanim billing buy --amount 10

# Generate an image
oanim assets gen-image --prompt "dark gradient" --out public/bg.png
```