http://api.example.comVersion: 0.20.42
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.42 of this API documentation.
Last update on May 16, 2025.
This API is provided under license AGPL 3.0.
curl \
--request POST 'http://api.example.com/auth/saml/sso' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/assets' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/asset-types/{asset_type_id}/casting' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/attachment-files' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{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/entity-types' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/departments/{instance_id}' \
--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/departments/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/organisations/{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/output-files' \
--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/day-offs/' \
--header "Authorization: $API_KEY"JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/asset-instances/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
--header "Authorization: $API_KEY"Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/search-filter-groups/' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
--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/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--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/edits/{edit_id}/versions' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/projects/{project_id}/edits' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/persons.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/export/csv/time-spents.csv' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/tasks/{task_id}/working-files/last-revisions' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/import/shotgun/errors' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/shotgun/remove/scene' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/persons' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/import/csv/projects/{project_id}/shots' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/status/resources' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/quota-shots/month/{year}/{month}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/persons/{person_id}/day-offs/year/{year}' \
--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 DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/episodes' \
--header "Authorization: $API_KEY"curl \
--request POST 'http://api.example.com/data/search' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/scenes/{scene_id}/task-types' \
--header "Authorization: $API_KEY"curl \
--request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/entities/{entity_id}/task-types/{task_type_id}/tasks' \
--header "Authorization: $API_KEY"curl \
--request GET 'http://api.example.com/data/user/scenes/{scene_id}/tasks' \
--header "Authorization: $API_KEY"to it.
curl \
--request GET 'http://api.example.com/data/user/projects/{project_id}/episodes' \
--header "Authorization: $API_KEY"