2026-10-14
12 min read
Overview#
Entity Management - View assets, shots, sequences, episodes, and tasks created with Kitsu directly in Prism.
Entity Creation - Create assets, shots, sequences, episodes, and tasks in Prism (when enabled in project settings).
Publishing - Publish media versions (renders, playblasts) and product versions to Kitsu.
Status Management - View and set statuses for tasks, product versions, and media versions.
Collaboration - Create and view notes and replies on tasks, product versions, and media versions, including image attachments on replies.
Assigned Tasks - View tasks assigned to the current user in the Project Browser.
Playlists - View and create Kitsu playlists, add published media versions, and display entries even when their media is not available locally.
Connected Entities - View asset-shot connections from Kitsu.
Thumbnails - Display and update thumbnails for Kitsu assets and shots from Prism.
Project Images - Update the connected Kitsu project's image from Prism.
Web Integration - Open the Kitsu page of any entity in a web browser directly from Prism.
Settings Sync - Sync departments, task statuses, fps, and resolution from Kitsu to Prism.
Memory Caching - Cache API requests for improved performance
Setup#
an active Kitsu site (either a payed site, a self hosted site or a local instance)
the ProjectManagement Prism plugin needs to be installed and loaded.
the Kitsu Prism plugin needs to be installed and loaded.
1. Activation
Prism Settings > Project > Project Management > Manager > Kitsu![[Kitsu - Setup Manager]](../../_static/plugins/kitsu/Kitsu_Setup_001.png)
2. Setup Kitsu
Setup... button:![[Kitsu - Setup Start]](../../_static/plugins/kitsu/Kitsu_Setup_002.png)
3. Kitsu URL
Hint
The screenshot shows a local Kitsu instance URL.
4. Kitsu Credentials
![[Kitsu - Setup Login]](../../_static/plugins/kitsu/Kitsu_Setup_004.png)
5. Project Selection
Next:
Note
Prism downloads the thumbnails for assets and shots, which may take a few seconds depending on the number of entities in your Kitsu project.
6. Setup Completion
![[Kitsu - Setup Complete]](../../_static/plugins/kitsu/Kitsu_Setup_006.png)
Project Settings#
The "Project Management" tab in the Prism Project Settings contains the following Kitsu-specific settings:
Setup... - Opens a setup window to guide you through the process of connecting your Kitsu project to your Prism project.
Url - The URL of your Kitsu instance.
Projectname - The name of the Kitsu project to connect to.
Status of published versions - The default status for published versions (default: wfa).
Show Task Status - Display the status icon and name for tasks in Prism (default: enabled).
Enable Product Publishes - Allow publishing product versions to Kitsu (default: enabled).
Enable Media Publishes - Allow publishing media versions to Kitsu (default: enabled).
Allow publishes from non-existent tasks - Allow publishing even when no matching Kitsu task is found (default: enabled).
Allow local tasks - Enable creation of local tasks in Prism, which don't exist in Kitsu (default: disabled).
Use short task names - Use shorter task names instead of full names (default: disabled).
Allow asset creation - Enable creation of assets in Prism (default: disabled).
Allow shot creation - Enable creation of shots in Prism (default: disabled).
Allow task creation - Enable creation of tasks in Prism (default: disabled).
Include full filepath in Kitsu comments - Attach the full local filepath when publishing to Kitsu (default: enabled).
Use Kitsu usernames - Use Kitsu usernames instead of local usernames (default: enabled).
Sync playlists - Show Kitsu playlists in Prism and allow creating playlists and adding published media versions (default: disabled). When disabled, Prism playlists are stored locally instead.
Auto Sync Departments - Automatically sync departments from Kitsu to Prism (default: disabled).
Auto Sync Asset-Shot connections - Automatically sync connections between assets and shots (default: disabled).
Sync Kitsu settings - Query existing departments in Kitsu and create matching departments in the Prism project. Also syncs the "Is Feedback Request" status, fps and resolution.
Create Asset-/Shot-Folders - Create folders in your project directory for all Kitsu assets, shots, and tasks.
Assets, Shots and Tasks#
Note
The folders of the tasks might not exist in your Prism project folder yet, but as soon as a scenefile gets saved under a task, all the required folders will be created.
Note
The creation of local assets, shots, departments and tasks, which don't exist in Kitsu can be enabled in the Project Settings.
Thumbnails and Project Images#
Note
If an image upload fails, the image remains saved locally in Prism. Check your connection and Kitsu permissions before trying again.
Product versions#
Media versions#
Version Statuses and Masters#
master version, Prism uses the numbered version from which the master was created. Viewing or changing the master's status therefore refers to that published source version; it does not create a separate master version in Kitsu.Notes, Replies and Images#
Show Notes... from the right-click menu of a task or published version to view its Kitsu discussion. Notes and replies are also available in the "Tasks" tab.Open the discussion and choose the note you want to reply to.
Open the reply editor, enter your message, and add the images you want to attach.
Submit the reply. Prism uploads the images with the reply and displays them when the discussion is loaded again.
Note
Reply images are ordinary image attachments. Markup included in an image is not transferred as editable Kitsu review annotations. Image attachments are supported in replies; this does not enable image uploads on new top-level notes.
Playlists and Dailies#
Sync playlists in the Kitsu Project Settings to use Kitsu playlists in the "Review" tab of the Prism Project Browser. With this setting disabled, playlists remain local to Prism and can contain local media without a Kitsu publish.Add published media
In the "Media" tab, publish the version to Kitsu with an uploaded preview. A publish containing only a comment or filepath is not enough for a Kitsu playlist.
In the "Review" tab, select a playlist and open
Add Media.Select the versions and click
Addto keep the picker open, orAcceptto add them and close it.
Version selection and limits
Prism adds the exact published preview of each selected version, not whichever preview is currently the latest in Kitsu.
Multiple published versions of the same shot or asset can appear in one playlist. Adding the same preview again does not create a duplicate.
Unpublished versions must be published first. Adding to a playlist does not upload media automatically.
If any selected version cannot be added, Prism rejects the whole selection and explains why. The picker stays open so you can correct the selection.
If more than one publish or preview matches a selected version, Prism asks you to resolve the ambiguity rather than choosing one silently.
A selection must match the playlist's entity type and any episode or task-type restrictions. Shot playlists cannot contain assets, and asset playlists cannot contain shots.
Prism supports existing shot and asset playlists. Playlists created from Prism are shot playlists; create an asset playlist in Kitsu before adding assets to it.
Adding media preserves the playlist's existing entries and order, including entries added by other users in Kitsu. Manage removals, reordering, and playlist deletion in Kitsu.
Versions without local media
remote only label. These remote-only items are not downloaded automatically and cannot be played or dragged into another application as local files.Server compatibility
Adding versions to synced playlists has been tested with Zou 1.0.94. Older Kitsu server installations may need an update. If adding media fails, check the reported error, your permissions, and the server version with your administrator. Refresh the playlist before retrying an addition whose result could not be confirmed.
Memory Caching#
Authentication#
In Prism, sign in to Kitsu with your email and account password, or enter a Kitsu API token instead. A token does not require an email or password. If both a token and password are present, Prism uses the token; clear the API token field in Prism User Settings and unset PRISM_KITSU_TOKEN to return to password login. An expired or revoked token must be replaced with a new one.
If your studio uses OpenID Connect for Kitsu login and you do not have a Kitsu password, use a long-lived personal API token issued by your Kitsu administrator or through your Kitsu account. Bot accounts can use their own API tokens. Keep tokens private, and set an appropriate expiration date. Prism uses the token directly; it does not open an OIDC browser login.
For password login with Kitsu two-factor authentication, enter the current TOTP code in the one-time code field. Prism does not store this code. After a successful login, Prism saves the returned login session with your other encrypted credentials and tries it again on the next launch. When that session expires or is revoked, you may need to enter a new code. Logging out clears the saved session. For unattended logins, use an API token instead.
Environment Variables#
The Kitsu plugin can be controlled using the following environment variables:
Name |
Description |
|---|---|
PRISM_KITSU_URL |
Sets the Kitsu URL, which Prism connects to. This overrides the URL in the project settings. (e.g. https://company.cg-wire.com) |
PRISM_KITSU_EMAIL |
The email to use for the login. (e.g. john@company.com) |
PRISM_KITSU_PASSWORD |
The Kitsu account password for email/password login; not an API token. |
PRISM_KITSU_TOKEN |
A Kitsu API token. Takes precedence over saved or environment-provided email and password; no email is required. |
PRISM_KITSU_USERNAME |
Author override for product publishes, media publishes, and notes. Accepts a Kitsu full name or email; does not change login credentials. |
PRISM_KITSU_DISABLE_SESSION_TOKEN_STORAGE |
Set to 1 to disable saving and restoring password-login session tokens. |
Environment variables override the corresponding saved credentials. Keep token and password variables out of shared logs and scripts.
Frequently Asked Questions#
Why can't I add a version to a Kitsu playlist?
Publish the version to Kitsu with an uploaded preview first. Then check that the playlist accepts the selected entity type, episode, and task type. If Prism reports multiple matching publishes or previews, resolve that ambiguity before retrying. Your account must have permission to update the playlist, and older server installations may need an update.
Why does a playlist version say "remote only"?
The preview exists in Kitsu, but Prism could not find a matching local media version. The item remains visible in the playlist, but local playback is unavailable. Restore the media to the expected Prism project location and refresh, or review the uploaded preview in Kitsu.
Why does the media publish fails on Linux with "ffmpeg conversion failed"?
On Linux ffmpeg needs to be installed on the system (i.e. via the Package-Manager).
The system ffmpeg can then be linked via the Prism Settings: Prism User Settings > Environment: Variable: PRISM_FFMPEG Value: ffmpeg
![[Logo: Kitsu]](../../_static/banner_logos/kitsu_logo.png)