Allow the user to change his password.

POST /auth/change-password
Jwt authorization

Prior to modifying the password, it requires to give the current password (to make sure the user changing the password is not someone who stealed the session). The new password requires a confirmation to ensure that the user didn't make a mistake by typing his new password.

Responses

  • 200

    Password changed

  • 400

    Invalid password or inactive user

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

Resource to allow a user to pre-register a FIDO device.

PUT /auth/fido
Jwt authorization

Responses

  • 200

    FIDO device pre-registered.

  • 400

    Invalid password Wrong or expired token Inactive user

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

Retrieve all asset types of assets casted in given shot.

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

Path parameters

  • shot_id Required

Responses

  • 200

    All asset types of assets casted in given shot

GET /data/shots/{shot_id}/asset-types 
curl \
 --request GET 'http://api.example.com/data/shots/a24a6ea4-ce75-4665-a070-57453082c25/asset-types' \
 --header "Authorization: $API_KEY"

Resource to allow the modification of assets linked to an entity.

PUT /data/projects/{project_id}/entities/{entity_id}/casting
Jwt authorization

Path parameters

  • project_id Required
  • entity_id Required

Responses

  • 200

    Modification of assets linked to an entity

PUT /data/projects/{project_id}/entities/{entity_id}/casting 
curl \
 --request PUT 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/casting' \
 --header "Authorization: $API_KEY"

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

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

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/entity-types/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/entity-types/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

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

GET /data/tasks/{instance_id}
Jwt authorization

Path parameters

  • instance_id Required

Responses

  • 200

    Model as a JSON object

  • 400

    Statement error

  • 404

    Value error

GET /data/tasks/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Update a model with data given in the request body.

PUT /data/entity-links/{instance_id}
Jwt authorization

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

PUT /data/entity-links/{instance_id} 
curl \
 --request PUT 'http://api.example.com/data/entity-links/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Export

Generate an output file path from file tree template

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path
Jwt authorization

Generate file path based on several parameters asset instance, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision in case no revision is given in parameter.

Path parameters

  • asset_instance_id Required
  • temporal_entity_id Required

Responses

  • 200

    Output file path generated

  • 400

    Malformed file tree

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-file-path 
curl \
 --request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-file-path' \
 --header "Authorization: $API_KEY"

Update comment on given working file.

PUT /actions/working-files/{working_file_id}/comment
Jwt authorization

Path parameters

  • working_file_id string(uuid) Required
application/json

Body Required

  • comment string Required

Responses

  • 200 application/json

    Comment updated on given working file

    Hide response attributes Show response attributes object
    • id string(uuid)
    • comment string
    • updated_at string(date-time)
  • 404

    Working file not found

PUT /actions/working-files/{working_file_id}/comment 
curl \
 --request PUT 'http://api.example.com/actions/working-files/a24a6ea4-ce75-4665-a070-57453082c25/comment' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"comment":"Updated lighting and materials"}'
Request examples 
{
  "comment": "Updated lighting and materials"
}
Response examples (200) 
{
  "id": "string",
  "comment": "string",
  "updated_at": "2025-05-04T09:42:00Z"
}

Import Kitsu resource.

POST /import/kitsu/projects
Jwt authorization

Responses

  • 200

    Resource imported

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

Create desktop login logs.

POST /data/persons/{person_id}/desktop-login-logs
Jwt authorization

Add a new log entry for desktop logins.

Path parameters

  • person_id string(uuid) Required
application/x-www-form-urlencoded

Body Required

  • date string(date) Required

Responses

  • 201 application/json

    Desktop login log entry created

    Hide response attributes Show response attributes object
    • id string(uuid)
    • person_id string(uuid)
    • date string(date-time)
  • 400

    Invalid date format

  • 404

    Person not found

POST /data/persons/{person_id}/desktop-login-logs 
curl \
 --request POST 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/desktop-login-logs' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'date=2022-07-12'
Response examples (201) 
{
  "id": "string",
  "person_id": "string",
  "date": "2025-05-04T09:42:00Z"
}

Return all day off recorded for given month and person.

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

Path parameters

  • person_id Required
  • year Required
  • month Required

Responses

  • 200

    All day off recorded for given month and person

GET /data/persons/{person_id}/day-offs/month/{year}/{month} 
curl \
 --request GET 'http://api.example.com/data/persons/a24a6ea4-ce75-4665-a070-57453082c25/day-offs/month/2022/7' \
 --header "Authorization: $API_KEY"

Download given playlist build as .mp4.

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

Path parameters

  • playlist_id string(uuid) Required
  • build_job_id string(uuid) Required

Responses

  • 200 video/mp4

    Given playlist build downloaded as .mp4
  • 400 application/json

    Build not finished, need to retry later

    Hide response attributes Show response attributes object
    • error boolean
    • message string
  • 404

    Playlist or build job not found

GET /data/playlists/{playlist_id}/jobs/{build_job_id}/build/mp4 
curl \
 --request GET 'http://api.example.com/data/playlists/a24a6ea4-ce75-4665-a070-57453082c25/jobs/a24a6ea4-ce75-4665-a070-57453082c25/build/mp4' \
 --header "Authorization: $API_KEY"
Response examples (400) 
{
  "error": true,
  "message": "string"
}