Log user out by revoking his auth tokens.
Once logged out, current user cannot access the API anymore.
curl \
--request GET 'http://api.example.com/auth/logout' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/auth/email-otp' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/auth/fido' \
--header "Authorization: $API_KEY"
Path parameters
-
asset_type_id
Required
curl \
--request GET 'http://api.example.com/data/asset-types/{asset_type_id}' \
--header "Authorization: $API_KEY"
Retrieve all entities that are not shot, sequence, episode, or edit.
Adds project name and asset type name.
curl \
--request GET 'http://api.example.com/data/assets/all' \
--header "Authorization: $API_KEY"
Path parameters
-
asset_id
Required
curl \
--request DELETE 'http://api.example.com/data/assets/{asset_id}' \
--header "Authorization: $API_KEY"
Retrieve the list of shots that cast given asset.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/cast-in' \
--header "Authorization: $API_KEY"
Retrieve all shot asset instances linked to given asset.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/shot-asset-instances' \
--header "Authorization: $API_KEY"
Retrieve all asset instances instantiated inside given asset.
Path parameters
-
asset_id
Required
curl \
--request GET 'http://api.example.com/data/assets/{asset_id}/asset-asset-instances' \
--header "Authorization: $API_KEY"
Resource to retrieve the casting of episodes.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/episodes/casting' \
--header "Authorization: $API_KEY"
Remove an asset instance from given shot.
Path parameters
-
shot_id
Required -
asset_instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/shots/{shot_id}/asset-instances/{asset_instance_id}' \
--header "Authorization: $API_KEY"
Add given files to the comment entry as attachments.
Path parameters
-
task_id
Required -
comment_id
Required
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/comments/{comment_id}/add-attachment' \
--header "Authorization: $API_KEY"
Creates new comments for given task. Each comments requires a text, a
task_status and a person as arguments.
Path parameters
-
task_id
Required
curl \
--request POST 'http://api.example.com/actions/tasks/{task_id}/batch-comment' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/entity-types/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entities' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/entities/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/task-types/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
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"
Retrieve a model corresponding at given ID and return it as a JSON
object.
Path parameters
-
output_file_id
Required
curl \
--request GET 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/output-files/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/output-types/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/preview-files' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/attachment-files' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/attachment-files/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/time-spents/' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/time-spents/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/asset-instances/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/playlists/' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/playlists/' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/events/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/search-filter-groups/' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/schedule-items/{instance_id}' \
--header "Authorization: $API_KEY"
Update a model with data given in the request body.
JSON format is expected. Model performs the validation automatically when fields are modified.
Path parameters
-
instance_id
Required
curl \
--request PUT 'http://api.example.com/data/news/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/milestones/' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/metadata-descriptors/' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/subscriptions/' \
--header "Authorization: $API_KEY"
Retrieve all entries for given model.
Filters can be specified in the query string.
curl \
--request GET 'http://api.example.com/data/entity-links/' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/entity-links/' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/entity-links/{instance_id}' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/chats/' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/chat-messages/' \
--header "Authorization: $API_KEY"
Create a model with data given in the request body.
JSON format is expected. The model performs the validation automatically when instantiated.
curl \
--request POST 'http://api.example.com/data/preview-background-files' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
Delete a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request DELETE 'http://api.example.com/data/salary-scales/{instance_id}' \
--header "Authorization: $API_KEY"
Retrieve a model corresponding at given ID and return it as a JSON object.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/data/plugins/{instance_id}' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/data/events/login-logs/last' \
--header "Authorization: $API_KEY"
Create new working file.
A working file is a file used to produce output files. It is the file the CG artist is working on. It is versioned, tied to a task and a software and requires a comment each time it is created. A path is generated for each file created. The path format is defined in the file tree template file.
Path parameters
-
task_id
Required
curl \
--request POST 'http://api.example.com/data/tasks/{task_id}/working-files/new' \
--header "Authorization: $API_KEY"
Get last revisions of output files for given instance grouped by output type and file name.
Path parameters
-
asset_instance_id
Required -
temporal_entity_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
curl \
--request GET 'http://api.example.com/data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/last-revisions' \
--header "Authorization: $API_KEY"
Get all output files for given poject.
Path parameters
-
project_id
Required
Query parameters
-
output_type_id
Required -
task_type_id
Required -
file_status_id
Required -
representation
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/output-files' \
--header "Authorization: $API_KEY"
Update comment on given working file.
Path parameters
-
working_file_id
Required
curl \
--request PUT 'http://api.example.com/actions/working-files/{working_file_id}/comment' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/scenes' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/assets' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/tasks' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/projectconnections' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/status' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/shotgun/remove/note' \
--header "Authorization: $API_KEY"
curl \
--request POST 'http://api.example.com/import/kitsu/entity-links' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status' \
--header "Authorization: $API_KEY"
curl \
--request GET 'http://api.example.com/status/resources' \
--header "Authorization: $API_KEY"
Query parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/news' \
--header "Authorization: $API_KEY"
Retrieve desktop login logs.
Desktop login logs can only be created by current user.
Path parameters
-
person_id
Required
curl \
--request GET 'http://api.example.com/data/persons/{person_id}/desktop-login-logs' \
--header "Authorization: $API_KEY"
Return a csv file containing the presence logs based on a daily basis.
Path parameters
-
month_date
Required
curl \
--request GET 'http://api.example.com/data/persons/presence-logs/{month_date}' \
--header "Authorization: $API_KEY"
Allow admin to change password for given user.
Prior to modifying the password, it requires to be admin. An admin can't change other admins password. The new password requires a confirmation to ensure that the admin didn't make a mistake by typing the new password.
Path parameters
-
person_id
Required
curl \
--request POST 'http://api.example.com/actions/persons/{person_id}/change-password' \
--header "Authorization: $API_KEY"
Allow admin to disable two factor authentication for given user.
Prior to disable two factor authentication, it requires to be admin. An admin can't disable two factor authentication for other admins.
Path parameters
-
person_id
Required
curl \
--request DELETE 'http://api.example.com/actions/persons/{person_id}/disable-two-factor-authentication' \
--header "Authorization: $API_KEY"
Retrieve all previews related to a given entity.
It sends them as a dict. Keys are related task type ids and values are arrays of preview for this task type.
Path parameters
-
entity_id
Required
curl \
--request GET 'http://api.example.com/data/playlists/entities/{entity_id}/preview-files' \
--header "Authorization: $API_KEY"
Path parameters
-
playlist_id
Required
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/build/mp4' \
--header "Authorization: $API_KEY"
Path parameters
-
playlist_id
Required
curl \
--request GET 'http://api.example.com/data/playlists/{playlist_id}/download/zip' \
--header "Authorization: $API_KEY"
Retrieve all playlists related to given project.
It's mainly used for synchronisation purpose.
Path parameters
-
project_id
Required
curl \
--request POST 'http://api.example.com/data/projects/{project_id}/playlists/temp' \
--header "Authorization: $API_KEY"
Main resource to add a preview.
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
-
instance_id
Required
curl \
--request POST 'http://api.example.com/pictures/preview-files/{instance_id}' \
--header "Authorization: $API_KEY"
Download the thumbnail linked to given object instance.
Path parameters
-
instance_id
Required
curl \
--request GET 'http://api.example.com/pictures/thumbnails/persons/{instance_id}' \
--header "Authorization: $API_KEY"
Create a thumbnail for given object instance.
Path parameters
-
instance_id
Required
curl \
--request POST 'http://api.example.com/pictures/thumbnails/persons/{instance_id}' \
--header "Authorization: $API_KEY"
Download a preview background file.
Path parameters
-
instance_id
Required -
extension
Required
curl \
--request GET 'http://api.example.com/pictures/preview-background-files/{instance_id}.{extension}' \
--header "Authorization: $API_KEY"
Retrieve task types linked to the production
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/task-types' \
--header "Authorization: $API_KEY"
Get a status automation linked to a production.
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/settings/status-automations' \
--header "Authorization: $API_KEY"
Remove a preview background file from a production.
Path parameters
-
project_id
Required -
preview_background_file_id
Required
curl \
--request DELETE 'http://api.example.com/data/projects/{project_id}/settings/preview-background-files/{preview_background_file_id}' \
--header "Authorization: $API_KEY"
Retrieve milestones for given production
Path parameters
-
project_id
Required
curl \
--request GET 'http://api.example.com/data/projects/{project_id}/milestones' \
--header "Authorization: $API_KEY"