Projects Overview

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.

​

Introduction

The Projects API provides endpoints for managing production projects in Zou/Kitsu. Projects are the top-level organizational unit that contain all production data including assets, shots, tasks, team members, and configuration settings.

​

What are Projects?

In Zou/Kitsu, a Project (also called a Production) represents a single animation, VFX, or creative production. Each project has its own team, assets, shots, tasks, schedules, and settings that are isolated from other projects.

​

Key Concepts

​

Project Model

Projects include the following key properties:

​

Production Styles

Projects can be classified by production style:

• 2d: 2D Animation
• 2dpaper: 2D Animation (Paper)
• 3d: 3D Animation
• 2d3d: 2D/3D Animation
• ar: Augmented Reality
• vfx: VFX
• stop-motion: Stop Motion
• motion-design: Motion Design
• archviz: Archviz
• commercial: Commercial
• catalog: Catalog
• immersive: Immersive Experience
• nft: NFT Collection
• video-game: Video Game
• vr: Virtual Reality

​

Project Configuration

​

Team Management

Projects have a team of people who can access and work on the project. Team membership is managed through:

• Adding team members (persons)
• Removing team members
• Department-based team grouping

​

Task Types & Statuses

Each project can configure which task types and task statuses are available:

• Task Types: Define the kinds of work (Modeling, Animation, Compositing, etc.)
• Task Statuses: Define workflow states (Todo, WIP, Waiting for Approval, Done, etc.)
• Priority: Order in which task types/statuses appear in the UI

​

Asset Types

Projects configure which asset types are available (Character, Prop, Environment, etc.). This determines what kinds of assets can be created in the project.

​

Metadata Descriptors

Custom fields that extend entity data:

• Entity Type: Asset, Shot, Edit, Episode, or Sequence
• Field Name: Name of the custom field
• Data Type: string, number, boolean, list, checklist, tags, etc.
• Choices: For list/dropdown fields
• For Client: Whether the field is visible to clients
• Departments: Which departments can see/edit the field

​

Budget Management

Projects can have budgets to track production costs:

• Budgets: Named budget sheets with currency
• Budget Entries: Individual line items with department, person, salary, duration
• Time Tracking: Integration with time spent data

​

Schedule Management

Projects support sophisticated scheduling:

• Milestones: Key production dates and deliverables
• Schedule Items: Task assignments with dates
• Schedule Versions: Snapshot and compare different scheduling scenarios
• Task Links: Dependencies between tasks
• Day Offs: Team member vacations and holidays

​

Status Automations

Projects can configure automated status transitions based on task completion and dependencies.

​

Common Workflows

​

Creating a Project

1. Create the project with basic information (name, type, dates)
2. Configure project settings (FPS, resolution, ratio)
3. Add team members
4. Set up task types and statuses
5. Configure asset types
6. Add metadata descriptors for custom fields
7. Set project to Open status

​

Project Configuration

​

Managing Project Settings

1. Access project settings endpoints
2. Add/remove task types with priorities
3. Add/remove task statuses
4. Configure asset types for the project
5. Set up status automations
6. Configure preview background files

​

Permissions

Project operations require different permission levels:

• View open projects: Any authenticated user
• View all projects: Manager or Admin
• Create projects: Admin
• Update project settings: Manager on project
• Delete projects: Admin
• Manage team: Manager on project
• View budgets: Manager on project
• View schedules: Project member (not vendor/client)

​

Project Statuses

Projects have lifecycle statuses:

• Open/Active: Currently in production
• Closed: Completed or archived
• Custom Statuses: Organizations can define their own

Open projects are the default view in most endpoints to focus on active work.

​

Filtering Projects

Most project endpoints support filtering by:

• name: Filter by project name
• project_status: Filter by status (open/closed)

The API provides two main project list endpoints:

• /data/projects/open: Only open/active projects (most common)
• /data/projects/all: All projects regardless of status (requires manager+)

​

Next Steps