Documentation Index
Fetch the complete documentation index at: https://mintlify.com/cgwire/zou/llms.txt
Use this file to discover all available pages before exploring further.
Welcome to Zou
Zou is the REST API that serves as the memory of your animation/VFX production. It allows you to store and manage all aspects of your production data, from projects and assets to tasks and previews, while keeping all your pipeline tools perfectly synchronized.What is Zou?
Zou is a Flask-based REST API that provides a comprehensive backend for managing animation and VFX production workflows. Through Zou, you can link all the tools in your pipeline and ensure they stay in sync through real-time event streaming. The API is designed to work seamlessly with Kitsu, the production management web application, and can be integrated into your custom tools using the Gazu Python client.Key Features
Production Data Management
Store and organize projects, shots, assets, tasks, and file metadata with a powerful relational model
Artist Progress Tracking
Monitor task assignments, time spent, and completion status across your entire team
Version Control
Track preview files and working files with full version history and comments
File Path Management
Generate consistent folder and file paths for any task using customizable file tree templates
CSV Import/Export
Bulk import production data and export reports in CSV format for easy integration
Real-Time Event Stream
Subscribe to live updates for synchronizing distributed tools and triggering workflows
JWT Authentication
Secure access with JSON Web Tokens supporting multiple authentication strategies
Role-Based Permissions
Fine-grained access control with roles (admin, manager, supervisor, artist, client, vendor)
Architecture Overview
Zou is built on a modern Python stack:- Flask - Lightweight web framework
- SQLAlchemy - ORM for database operations
- PostgreSQL - Primary data store
- Redis - Caching and token management
- Gunicorn - Production WSGI server
- JWT - Token-based authentication
Get Started
Installation
Set up Zou with PostgreSQL, Redis, and Python dependencies
Quick Start
Get the API running and make your first authenticated request
API Reference
Explore all available endpoints and their parameters
Authentication
Learn about login, tokens, and security features
Use Cases
Zou powers production workflows at studios worldwide:- Asset and Shot Management - Organize your production hierarchy
- Task Assignment - Distribute work and track progress
- Review and Approval - Comment on previews and manage revisions
- Pipeline Integration - Connect DCC tools (Maya, Blender, Houdini) to production data
- Scheduling - Plan milestones and track delivery dates
- Team Collaboration - Share updates and communicate across departments
Community and Support
Zou is developed by CGWire and is used by over 70 studios worldwide.GitHub
Source code and issue tracking
Discord
Join the community chat
Documentation
Official documentation site
Technical Requirements
- Python 3.10 or higher (up to 3.14)
- PostgreSQL 12 or higher
- Redis 5.0 or higher
- 2GB RAM minimum (4GB+ recommended)
- Linux, macOS, or Windows