http://api.example.comVersion: 0.20.55
The Kitsu API allows to store and manage the data of your animation/VFX production. Through it you can link all the tools of your pipeline and make sure they are all synchronized.
An easy to use Python client to access this API is available: Python Kitsu Client documentation
Before you can use any of the endpoints outline below, you will have to get a JWT token to authorize your requests.
You will find the information to retrieve it in the Zou documentation.
This is version 0.20.55 of this API documentation.
Last update on Jun 17, 2025.
This API is provided under license AGPL 3.0.
Adds project name and asset type name.
curl \
--request GET 'http://api.example.com/data/assets/all' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"It's mainly used for synchronisation purpose.
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/entity-links/{entity_link_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/project-status/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/softwares/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/time-spents/' \
--header "Authorization: $API_KEY"JSON format is expected. Model performs the validation automatically when fields are modified.
curl \
--request PUT 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/custom-actions/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/playlists/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/preview-background-files' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/preview-background-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/plugins' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/tasks.csv' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/entities/{entity_id}/output-files/next-revision' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/projects' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/shots' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/steps' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/notes' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/episode' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/status/influx' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/config' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/news/{news_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/actions/persons/{person_id}/departments/add' \
--header "Authorization: $API_KEY"It stores the preview file and generates three picture files matching preview when it's possible: a square thumbnail, a rectangle thumbnail and a midsize file.
curl \
--request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/task-types' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/task-types/{task_type_id}' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"Descriptors serve to describe extra fields listed in the data attribute of entities.
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/metadata-descriptors/{descriptor_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/scenes/{scene_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/episodes/{episode_id}/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/comments/{comment_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/user/sequences/{sequence_id}/task-types' \
--header "Authorization: $API_KEY"