Kitsu API
0.20.55

Base URL 
http://api.example.com

Welcome to the Kitsu API specification

Version: 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

Authentication

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.

OpenAPI definition

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.

Log in user by creating and registering auth tokens.

POST /auth/login
Jwt authorization

Login is based on email and password. If no user match given email and a destkop ID, it looks in matching the desktop ID with the one stored in database. It is useful for clients that run on desktop tools and that don't know user email.

Responses

POST /auth/login 
curl \
 --request POST 'http://api.example.com/auth/login' \
 --header "Authorization: $API_KEY"

Resource to get a challenge for a FIDO device.

GET /auth/fido
Jwt authorization

Responses

  • 200

    Challenge for FIDO device.

  • 400

    Wrong parameter.

GET /auth/fido 
curl \
 --request GET 'http://api.example.com/auth/fido' \
 --header "Authorization: $API_KEY"

Retrieve all asset types (entity types that are not shot, sequence or episode).

GET /data/asset-types
Jwt authorization

Responses

GET /data/asset-types 
curl \
 --request GET 'http://api.example.com/data/asset-types' \
 --header "Authorization: $API_KEY"

Retrieve all entities that are not shot, sequence, episode, or edit.

GET /data/assets
Jwt authorization

Adds project name and asset type name.

GET /data/assets 
curl \
 --request GET 'http://api.example.com/data/assets' \
 --header "Authorization: $API_KEY"

Retrieve given asset.

GET /data/assets/{asset_id}
Jwt authorization

Responses

GET /data/assets/{asset_id} 
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to given asset.

GET /data/assets/{asset_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given asset

GET /data/assets/{asset_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all task types of tasks related to given asset.

GET /data/assets/{asset_id}/task-types
Jwt authorization

Responses

  • 200

    All task types of tasks related to given asset

GET /data/assets/{asset_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all scene asset instances linked to given asset.

GET /data/assets/{asset_id}/scene-asset-instances
Jwt authorization

Responses

  • 200

    All scene asset instances linked to given asset

GET /data/assets/{asset_id}/scene-asset-instances 
curl \
 --request GET 'http://api.example.com/data/assets/{asset_id}/scene-asset-instances' \
 --header "Authorization: $API_KEY"

Share or unshare all assets for given project and asset type.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share
Jwt authorization

Path parameters

Responses

  • 201

    All assets modified.

POST /actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/asset-types/{asset_type_id}/assets/share' \
 --header "Authorization: $API_KEY"

Resource to retrieve the casting of shots from given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting
Jwt authorization

Responses

  • 200

    Casting for all shots from given episode.

GET /data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/episodes/{episode_id}/sequences/all/casting' \
 --header "Authorization: $API_KEY"

Retrieve all asset instances linked to scene.

GET /data/scenes/{scene_id}/asset-instances
Jwt authorization

Responses

  • 200

    All asset instances linked to given scene

GET /data/scenes/{scene_id}/asset-instances 
curl \
 --request GET 'http://api.example.com/data/scenes/{scene_id}/asset-instances' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/persons/{instance_id}
Jwt authorization

Responses

GET /data/persons/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/persons/{instance_id}' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/project-status
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/project-status 
curl \
 --request POST 'http://api.example.com/data/project-status' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/project-status/{instance_id}
Jwt authorization

Responses

GET /data/project-status/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/project-status/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/entity-types
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/entity-types 
curl \
 --request GET 'http://api.example.com/data/entity-types' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/tasks
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/tasks 
curl \
 --request GET 'http://api.example.com/data/tasks' \
 --header "Authorization: $API_KEY"

Create a model with data given in the request body.

POST /data/departments
Jwt authorization

JSON format is expected. The model performs the validation automatically when instantiated.

Responses

POST /data/departments 
curl \
 --request POST 'http://api.example.com/data/departments' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/departments/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/departments/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/departments/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/departments/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/departments/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/departments/{instance_id}' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/file-status/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/file-status/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/file-status/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve an output type corresponding at given ID and return it as a

GET /data/output-types/{instance_id}
Jwt authorization

JSON object.

Responses

GET /data/output-types/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/output-types/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/attachment-files
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/attachment-files 
curl \
 --request GET 'http://api.example.com/data/attachment-files' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/attachment-files/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/attachment-files/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/attachment-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/attachment-files/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/attachment-files/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/attachment-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/day-offs/{instance_id}
Jwt authorization

Responses

GET /data/day-offs/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/day-offs/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/asset-instances/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/asset-instances/ 
curl \
 --request GET 'http://api.example.com/data/asset-instances/' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/events/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/events/ 
curl \
 --request GET 'http://api.example.com/data/events/' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/events/{instance_id}
Jwt authorization

JSON format is expected. Model performs the validation automatically when fields are modified.

Responses

PUT /data/events/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/events/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/search-filters/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/search-filters/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/search-filters/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/search-filter-groups/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/search-filter-groups/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/search-filter-groups/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/news/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/news/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/news/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/milestones/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/milestones/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/milestones/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/metadata-descriptors/{instance_id}
Jwt authorization

Responses

GET /data/metadata-descriptors/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/metadata-descriptors/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/subscriptions/
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/subscriptions/ 
curl \
 --request GET 'http://api.example.com/data/subscriptions/' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/chats/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/chats/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/chats/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve a model corresponding at given ID and return it as a JSON object.

GET /data/chat-messages/{instance_id}
Jwt authorization

Responses

GET /data/chat-messages/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/chat-messages/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/preview-background-files/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/preview-background-files/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/preview-background-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Delete a model corresponding at given ID and return it as a JSON object.

DELETE /data/plugins/{instance_id}
Jwt authorization

Responses

  • 204

    Model deleted

  • 400

    Statement or integrity error

  • 404

    Instance non-existant

DELETE /data/plugins/{instance_id} 
curl \
 --request DELETE 'http://api.example.com/data/plugins/{instance_id}' \
 --header "Authorization: $API_KEY"

Retrieve all entries for given model.

GET /data/plugins
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/plugins 
curl \
 --request GET 'http://api.example.com/data/plugins' \
 --header "Authorization: $API_KEY"

Retrieve all edit entries.

GET /data/edits/all
Jwt authorization

Filters can be specified in the query string.

Responses

GET /data/edits/all 
curl \
 --request GET 'http://api.example.com/data/edits/all' \
 --header "Authorization: $API_KEY"

Delete given edit.

DELETE /data/edits/{edit_id}
Jwt authorization

Responses

DELETE /data/edits/{edit_id} 
curl \
 --request DELETE 'http://api.example.com/data/edits/{edit_id}' \
 --header "Authorization: $API_KEY"

Retrieve all edits related to a given episode.

GET /data/episodes/{episode_id}/edits
Jwt authorization

Responses

  • 200

    All efits related to given episode

GET /data/episodes/{episode_id}/edits 
curl \
 --request GET 'http://api.example.com/data/episodes/{episode_id}/edits' \
 --header "Authorization: $API_KEY"

Retrieve all edits related to a given project.

GET /data/projects/{project_id}/edits
Jwt authorization

Responses

  • 200

    All edits related to given project

GET /data/projects/{project_id}/edits 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/edits' \
 --header "Authorization: $API_KEY"

Export shots linked to a given project as csv.

GET /export/csv/projects/{project_id}/shots.csv
Jwt authorization

Responses

  • 200

    Shots exported as csv

GET /export/csv/projects/{project_id}/shots.csv 
curl \
 --request GET 'http://api.example.com/export/csv/projects/{project_id}/shots.csv' \
 --header "Authorization: $API_KEY"

Export as csv.

GET /export/csv/projects.csv
Jwt authorization

Responses

GET /export/csv/projects.csv 
curl \
 --request GET 'http://api.example.com/export/csv/projects.csv' \
 --header "Authorization: $API_KEY"

Generate a working file path from file tree template.

POST /data/tasks/{task_id}/working-file-path
Jwt authorization

Generate file path based on several parameters: task, software, mode, revision and separator. Revision can be computed automatically as next revision if not given.

Path parameters

Responses

  • 200

    Working file path generated

  • 400

    Malformed file tree

POST /data/tasks/{task_id}/working-file-path 
curl \
 --request POST 'http://api.example.com/data/tasks/{task_id}/working-file-path' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projects
Jwt authorization

Responses

POST /import/shotgun/projects 
curl \
 --request POST 'http://api.example.com/import/shotgun/projects' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/sequences
Jwt authorization

Responses

POST /import/shotgun/sequences 
curl \
 --request POST 'http://api.example.com/import/shotgun/sequences' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/shots
Jwt authorization

Responses

POST /import/shotgun/shots 
curl \
 --request POST 'http://api.example.com/import/shotgun/shots' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/tasks
Jwt authorization

Responses

POST /import/shotgun/tasks 
curl \
 --request POST 'http://api.example.com/import/shotgun/tasks' \
 --header "Authorization: $API_KEY"

Import shotgun resource.

POST /import/shotgun/projectconnections
Jwt authorization

Responses

POST /import/shotgun/projectconnections 
curl \
 --request POST 'http://api.example.com/import/shotgun/projectconnections' \
 --header "Authorization: $API_KEY"

Import remove instance.

POST /import/shotgun/remove/episode
Jwt authorization

Responses

POST /import/shotgun/remove/episode 
curl \
 --request POST 'http://api.example.com/import/shotgun/remove/episode' \
 --header "Authorization: $API_KEY"

Import project casting links via a .csv file.

POST /import/csv/projects/{project_id}/casting
Jwt authorization

Path parameters

Responses

  • 201

    The lists of imported casting links.

  • 400

    The .csv file is not properly formatted.

POST /import/csv/projects/{project_id}/casting 
curl \
 --request POST 'http://api.example.com/import/csv/projects/{project_id}/casting' \
 --header "Authorization: $API_KEY"

Import Kitsu resource.

POST /import/kitsu/tasks
Jwt authorization

Responses

POST /import/kitsu/tasks 
curl \
 --request POST 'http://api.example.com/import/kitsu/tasks' \
 --header "Authorization: $API_KEY"

Retrieve date and CPU, memory and jobs stats.

GET /status/resources
Jwt authorization

Responses

  • 200

    Date and CPU, memory and jobs stats

GET /status/resources 
curl \
 --request GET 'http://api.example.com/status/resources' \
 --header "Authorization: $API_KEY"

Get basic configuration for the current instance.

GET /config
Jwt authorization

Responses

  • 200

    Configuration object including self-hosted status, Crisp token, indexer configuration, SAML status, and dark theme status.

GET /config 
curl \
 --request GET 'http://api.example.com/config' \
 --header "Authorization: $API_KEY"

Retrieve all news related to a given project

GET /data/projects/{project_id}/news
Jwt authorization

Responses

  • 200

    All news related to given project

GET /data/projects/{project_id}/news 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/news' \
 --header "Authorization: $API_KEY"

Return a csv file containing the presence logs based on a daily basis.

GET /data/persons/presence-logs/{month_date}
Jwt authorization

Responses

  • 200

    CSV file containing the presence logs based on a daily basis

GET /data/persons/presence-logs/{month_date} 
curl \
 --request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
 --header "Authorization: $API_KEY"

Get day off object for given person and date.

GET /data/persons/{person_id}/day-offs/{date}
Jwt authorization

Responses

  • 200

    Day off object for given person and date

  • 404

    Wrong date format

GET /data/persons/{person_id}/day-offs/{date} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/day-offs/{date}' \
 --header "Authorization: $API_KEY"

Return a table giving time spent by user and by month for given year.

GET /data/persons/time-spents/month-table/{year}
Jwt authorization

Responses

  • 200

    Table giving time spent by user and by month for given year

GET /data/persons/time-spents/month-table/{year} 
curl \
 --request GET 'http://api.example.com/data/persons/time-spents/month-table/{year}' \
 --header "Authorization: $API_KEY"

Return a table giving time spent by user and by week for given year.

GET /data/persons/time-spents/week-table/{year}
Jwt authorization

Responses

  • 200

    Table giving time spent by user and by week for given year

GET /data/persons/time-spents/week-table/{year} 
curl \
 --request GET 'http://api.example.com/data/persons/time-spents/week-table/{year}' \
 --header "Authorization: $API_KEY"

Sends an email to given person to invite him/her to connect to Kitsu.

GET /actions/persons/{person_id}/invite
Jwt authorization
GET /actions/persons/{person_id}/invite 
curl \
 --request GET 'http://api.example.com/actions/persons/{person_id}/invite' \
 --header "Authorization: $API_KEY"

Allow admin to disable two factor authentication for given user.

DELETE /actions/persons/{person_id}/disable-two-factor-authentication
Jwt authorization

Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.

Responses

  • 200

    Two factor authentication disabled

  • 400

    Inactive user

DELETE /actions/persons/{person_id}/disable-two-factor-authentication 
curl \
 --request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
 --header "Authorization: $API_KEY"

Retrieve build job related to given playlist.

GET /data/playlists/{playlist_id}/jobs/{build_job_id}
Jwt authorization

Responses

  • 200

    Build job related to given playlist

GET /data/playlists/{playlist_id}/jobs/{build_job_id} 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/jobs/{build_job_id}' \
 --header "Authorization: $API_KEY"

Build given playlist as mp4 movie.

GET /data/playlists/{playlist_id}/build/mp4
Jwt authorization

Responses

  • 200

    Given playlist built as mp4 movie

GET /data/playlists/{playlist_id}/build/mp4 
curl \
 --request GET 'http://api.example.com/data/playlists/{playlist_id}/build/mp4' \
 --header "Authorization: $API_KEY"

Main resource to add a preview.

POST /pictures/preview-files/{instance_id}
Jwt authorization

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.

Path parameters

Responses

POST /pictures/preview-files/{instance_id} 
curl \
 --request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
 --header "Authorization: $API_KEY"

Download a movie preview.

GET /movies/originals/preview-files/{instance_id}/download
Jwt authorization

Responses

GET /movies/originals/preview-files/{instance_id}/download 
curl \
 --request GET 'http://api.example.com/movies/originals/preview-files/{instance_id}/download' \
 --header "Authorization: $API_KEY"

Download the thumbnail representing given attachment file.

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png
Jwt authorization

Responses

  • 200

    Thumbnail downloaded

  • 403

    Instance not allowed

  • 404

    Picture file not found

GET /pictures/thumbnails/attachment-files/{attachment_file_id}.png 
curl \
 --request GET 'http://api.example.com/pictures/thumbnails/attachment-files/{attachment_file_id}.png' \
 --header "Authorization: $API_KEY"

Create a thumbnail for given object instance.

POST /pictures/thumbnails/organisations/{instance_id}
Jwt authorization

Path parameters

Responses

  • 200

    Thumbnail created

  • 404

    Cannot found related object.

POST /pictures/thumbnails/organisations/{instance_id} 
curl \
 --request POST 'http://api.example.com/pictures/thumbnails/organisations/{instance_id}' \
 --header "Authorization: $API_KEY"

Download a preview background file.

GET /pictures/preview-background-files/{instance_id}.{extension}
Jwt authorization

Responses

  • 200

    Preview background file downloaded

  • 404

    Preview background file not found

GET /pictures/preview-background-files/{instance_id}.{extension} 
curl \
 --request GET 'http://api.example.com/pictures/preview-background-files/{instance_id}.{extension}' \
 --header "Authorization: $API_KEY"

Return the people listed in a production team.

GET /data/projects/{project_id}/team
Jwt authorization

Responses

  • 200

    People listed in a production team

GET /data/projects/{project_id}/team 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/team' \
 --header "Authorization: $API_KEY"

Add an asset type linked to a production.

POST /data/projects/{project_id}/settings/asset-types
Jwt authorization

Path parameters

Responses

  • 201

    Asset type added to production

POST /data/projects/{project_id}/settings/asset-types 
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/settings/asset-types' \
 --header "Authorization: $API_KEY"

Remove an asset type from a production.

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id}
Jwt authorization

Responses

DELETE /data/projects/{project_id}/settings/asset-types/{asset_type_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/settings/asset-types/{asset_type_id}' \
 --header "Authorization: $API_KEY"

Return preview background files linked to a production

GET /data/projects/{project_id}/settings/preview-background-files
Jwt authorization

Responses

  • 200

    Preview background files linked to production

GET /data/projects/{project_id}/settings/preview-background-files 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files' \
 --header "Authorization: $API_KEY"

Retrieve sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences
Jwt authorization

Responses

  • 200

    All sequences schedule items for given task type

GET /data/projects/{project_id}/schedule-items/{task_type_id}/sequences 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/schedule-items/{task_type_id}/sequences' \
 --header "Authorization: $API_KEY"

Delete a budget for given production

DELETE /data/projects/{project_id}/budgets/{budget_id}
Jwt authorization

Responses

DELETE /data/projects/{project_id}/budgets/{budget_id} 
curl \
 --request DELETE 'http://api.example.com/data/projects/{project_id}/budgets/{budget_id}' \
 --header "Authorization: $API_KEY"

Get aggregated time spents by month for given project.

GET /data/projects/{project_id}/budgets/time-spents
Jwt authorization

Responses

  • 200

    Aggregated time spents for given person and month

  • 400

    Wrong ID format

GET /data/projects/{project_id}/budgets/time-spents 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/budgets/time-spents' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given shot.

GET /data/shots/{shot_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given shot

GET /data/shots/{shot_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_id}/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given shot.

GET /data/shots/{shot_id}/tasks
Jwt authorization

Responses

  • 200

    All tasks related to given shot

GET /data/shots/{shot_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_id}/tasks' \
 --header "Authorization: $API_KEY"

Retrieve all previews related to a given shot.

GET /data/shots/{shot_id}/preview-files
Jwt authorization

It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.

Responses

  • 200

    All previews related to given episode

GET /data/shots/{shot_id}/preview-files 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_id}/preview-files' \
 --header "Authorization: $API_KEY"

Retrieve data versions of given shot.

GET /data/shots/{shot_id}/versions
Jwt authorization

Responses

  • 204

    Data versions of given shot

GET /data/shots/{shot_id}/versions 
curl \
 --request GET 'http://api.example.com/data/shots/{shot_id}/versions' \
 --header "Authorization: $API_KEY"

Retrieve given scene.

GET /data/scenes/{scene_id}
Jwt authorization

Responses

GET /data/scenes/{scene_id} 
curl \
 --request GET 'http://api.example.com/data/scenes/{scene_id}' \
 --header "Authorization: $API_KEY"

Retrieve given episode.

GET /data/episodes/{episode_id}
Jwt authorization

Responses

GET /data/episodes/{episode_id} 
curl \
 --request GET 'http://api.example.com/data/episodes/{episode_id}' \
 --header "Authorization: $API_KEY"

Delete given sequence.

DELETE /data/sequences/{sequence_id}
Jwt authorization

Responses

  • 204

    Given sequence deleted

DELETE /data/sequences/{sequence_id} 
curl \
 --request DELETE 'http://api.example.com/data/sequences/{sequence_id}' \
 --header "Authorization: $API_KEY"

Retrieve all task types related to a given shot.

GET /data/sequences/{sequence_id}/task-types
Jwt authorization

Responses

  • 200

    All task types related to given shot

GET /data/sequences/{sequence_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/sequences/{sequence_id}/task-types' \
 --header "Authorization: $API_KEY"

Retrieve all tasks related to a given sequence.

GET /data/sequences/{sequence_id}/shot-tasks
Jwt authorization

Responses

  • 200

    All task types related to given sequence

GET /data/sequences/{sequence_id}/shot-tasks 
curl \
 --request GET 'http://api.example.com/data/sequences/{sequence_id}/shot-tasks' \
 --header "Authorization: $API_KEY"

Create a shot for given project.

POST /data/projects/{project_id}/shots
Jwt authorization

Path parameters

Responses

  • 201

    Shot created for given project

POST /data/projects/{project_id}/shots 
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/shots' \
 --header "Authorization: $API_KEY"

Create a scene for given project.

POST /data/projects/{project_id}/scenes
Jwt authorization

Path parameters

Responses

  • 201

    Scene created for given project

POST /data/projects/{project_id}/scenes 
curl \
 --request POST 'http://api.example.com/data/projects/{project_id}/scenes' \
 --header "Authorization: $API_KEY"

Retrieve all episodes related to a given project.

GET /data/projects/{project_id}/episodes
Jwt authorization

Responses

  • 200

    All episodes related to given project

GET /data/projects/{project_id}/episodes 
curl \
 --request GET 'http://api.example.com/data/projects/{project_id}/episodes' \
 --header "Authorization: $API_KEY"

Return comments linked to given task.

GET /data/tasks/{task_id}/comments
Jwt authorization

Responses

  • 200

    Comments linked to given task

GET /data/tasks/{task_id}/comments 
curl \
 --request GET 'http://api.example.com/data/tasks/{task_id}/comments' \
 --header "Authorization: $API_KEY"

For all entities assigned to given person (that have at least one task assigned to given person), returns all tasks for given task type.

GET /data/persons/{person_id}/related-tasks/{task_type_id}
Jwt authorization
GET /data/persons/{person_id}/related-tasks/{task_type_id} 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/related-tasks/{task_type_id}' \
 --header "Authorization: $API_KEY"

Return task assigned to given user of which status has is_done flag sets to true.

GET /data/persons/{person_id}/done-tasks
Jwt authorization

It return only tasks related to open projects.

Responses

  • 200

    Tasks assigned to user that are done

GET /data/persons/{person_id}/done-tasks 
curl \
 --request GET 'http://api.example.com/data/persons/{person_id}/done-tasks' \
 --header "Authorization: $API_KEY"

Return tasks related to given entity asset, episode, sequence, shot or scene.

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given entity asset, episode, sequence, shot or scene

GET /data/entities/{entity_id}/task-types/{task_type_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/entities/{entity_id}/task-types/{task_type_id}/tasks' \
 --header "Authorization: $API_KEY"

Delete tasks matching id list given in parameter.

POST /actions/projects/{project_id}/delete-tasks
Jwt authorization

See it as a way to batch delete tasks.

Path parameters

Responses

  • 200

    Tasks matching id list given in parameter deleted

POST /actions/projects/{project_id}/delete-tasks 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/delete-tasks' \
 --header "Authorization: $API_KEY"

Create a new task with given task type for each entity of given

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/
Jwt authorization

entity type.

Path parameters

Responses

  • 201

    List of created tasks.

POST /actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/ 
curl \
 --request POST 'http://api.example.com/actions/projects/{project_id}/task-types/{task_type_id}/create-tasks/{entity_type}/' \
 --header "Authorization: $API_KEY"

Return tasks related to given shot for current user.

GET /data/user/shots/{shot_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given shot

GET /data/user/shots/{shot_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/user/shots/{shot_id}/tasks' \
 --header "Authorization: $API_KEY"

Return tasks related to given sequence for current user.

GET /data/user/sequences/{sequence_id}/tasks
Jwt authorization

Responses

  • 200

    Tasks related to given sequence

GET /data/user/sequences/{sequence_id}/tasks 
curl \
 --request GET 'http://api.example.com/data/user/sequences/{sequence_id}/tasks' \
 --header "Authorization: $API_KEY"

Return task types related to given asset for current user.

GET /data/user/assets/{asset_id}/task-types
Jwt authorization

Responses

  • 200

    Task types related to given asset for current user

GET /data/user/assets/{asset_id}/task-types 
curl \
 --request GET 'http://api.example.com/data/user/assets/{asset_id}/task-types' \
 --header "Authorization: $API_KEY"

Return assets of which type is given asset type and are listed in given

GET /data/user/projects/{project_id}/asset-types/{asset_type_id}/assets
Jwt authorization

project if user has access to this project.

Responses

  • 200

    Assets of which type is given asset type and are listed in given project

GET /data/user/projects/{project_id}/asset-types/{asset_type_id}/assets 
curl \
 --request GET 'http://api.example.com/data/user/projects/{project_id}/asset-types/{asset_type_id}/assets' \
 --header "Authorization: $API_KEY"

Update given filter if it's owned by current user.

PUT /data/user/filters/{filter_id}
Jwt authorization

Responses

  • 200

    Given filter with updated data.

PUT /data/user/filters/{filter_id} 
curl \
 --request PUT 'http://api.example.com/data/user/filters/{filter_id}' \
 --header "Authorization: $API_KEY"

Retrieve given filter group for the current user.

GET /data/user/filter-groups/{filter_group_id}
Jwt authorization

Responses

  • 200

    Filter groups for the current user and only for open projects

GET /data/user/filter-groups/{filter_group_id} 
curl \
 --request GET 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Update given filter group if it's owned by the current user.

PUT /data/user/filter-groups/{filter_group_id}
Jwt authorization

Responses

  • 200

    Given filter group with updated data

PUT /data/user/filter-groups/{filter_group_id} 
curl \
 --request PUT 'http://api.example.com/data/user/filter-groups/{filter_group_id}' \
 --header "Authorization: $API_KEY"

Set last preview from given task as main preview of the related entity.

PUT /actions/tasks/{task_id}/set-main-preview
Jwt authorization

This preview will be used as thumbnail to illustrate the entity.

Responses

  • 200

    Given preview set as main preview

PUT /actions/tasks/{task_id}/set-main-preview 
curl \
 --request PUT 'http://api.example.com/actions/tasks/{task_id}/set-main-preview' \
 --header "Authorization: $API_KEY"

Delete given concept.

DELETE /data/concepts/{concept_id}
Jwt authorization

Responses

  • 204

    Given concept deleted

DELETE /data/concepts/{concept_id} 
curl \
 --request DELETE 'http://api.example.com/data/concepts/{concept_id}' \
 --header "Authorization: $API_KEY"