Prerequisites
- Node.js 18+
- PostgreSQL 15+
- A fal.ai API key (for asset generation)
- AWS credentials with S3 + Lambda access (for cloud rendering)
- A Stripe account (for billing, optional)
- A Clerk application (for authentication)
Quick start with Docker
Environment variables
New users receive a $5.00 credit balance on signup. Without Stripe configured, users won’t be able to purchase additional credits, but existing balances still work.
Direct provider keys
For asset generation without running the platform API, users can setANIMATE_FAL_KEY to go directly to fal.ai:
docker-compose.yml
The includeddocker-compose.yml runs PostgreSQL:
Production considerations
For production deployments:- Database: Use strong passwords, enable SSL, and set up regular backups
- Stripe webhooks: Configure the webhook endpoint at
https://your-domain/api/v1/billing/webhook - Rate limiting: The API includes in-memory rate limiting (60 req/min for media, 10 req/min for auth). For multi-instance deployments, consider adding a Redis-backed rate limiter
- HTTPS: Place the API behind a reverse proxy (nginx, Caddy) with TLS