Delete studio

Get asset

GET /data/assets/{asset_id}

Jwt authorization

Retrieve detailed information about a specific asset including metadata, project context, and related data

Path parameters

asset_id Required

Unique identifier of the asset

Responses

200 application/json

Asset information successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset unique identifier
- name string
  
  Asset name
- project_id string(uuid)
  
  Project identifier
- entity_type_id string(uuid)
  
  Asset type identifier
- created_at string(date-time)
  
  Creation timestamp
- updated_at string(date-time)
  
  Last update timestamp

GET /data/assets/{asset_id}

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Character Name",
  "project_id": "b35b7fb5-df86-5776-b181-68564193d36",
  "entity_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}

Get project asset types

GET /data/projects/{project_id}/asset-types

Jwt authorization

Retrieve all asset types available for a specific project

Path parameters

project_id Required

Unique identifier of the project

Responses

200 application/json

List of project asset types successfully retrieved
Hide response attributes Show response attributes object
- id string(uuid)
  
  Asset type unique identifier
- name string
  
  Asset type name
- project_id string(uuid)
  
  Project identifier

GET /data/projects/{project_id}/asset-types

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

Response examples (200)

[
  {
    "id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "name": "Character",
    "project_id": "b35b7fb5-df86-5776-b181-68564193d36"
  }
]

Delete chat message

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id}

Jwt authorization

Delete a specific chat message. Only the message author or administrators can delete messages.

Path parameters

entity_id Required

ID of the entity related to the chat
chat_message_id Required

ID of the chat message to delete

Responses

204

Chat message successfully deleted

DELETE /data/entities/{entity_id}/chat/messages/{chat_message_id}

curl \
 --request DELETE 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/chat/messages/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Create multiple comments

POST /actions/projects/{project_id}/tasks/comment-many

Jwt authorization

Create several comments at once for a specific project. Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with the given task status.

Path parameters

project_id Required

Unique identifier of the project

application/json

Body Required

task_status_id string(uuid) Required

Task status identifier
comment string

Comment text content
person_id string(uuid)

Person identifier (optional, defaults to current user)
object_id string(uuid) Required

Task identifier
created_at string(date-time)

Creation timestamp (optional, defaults to current time)
checklist object

Checklist items for the comment
links array[string]

List of related links

Responses

201 application/json

Comments successfully created
Hide response attributes Show response attributes object
- id string(uuid)
  
  Comment unique identifier
- task_id string(uuid)
  
  Task identifier
- person_id string(uuid)
  
  Person identifier
- comment string
  
  Comment text content
- task_status_id string(uuid)
  
  Task status identifier
- created_at string(date-time)
  
  Creation timestamp

POST /actions/projects/{project_id}/tasks/comment-many

curl \
 --request POST 'http://api.example.com/actions/projects/a24a6ea4-ce75-4665-a070-57453082c25/tasks/comment-many' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"task_status_id":"c46c8gc6-eg97-6887-c292-79675204e47","comment":"This looks great! Ready for review.","person_id":"d57d9hd7-fh08-7998-d403-80786315f58","object_id":"e68e0ie8-gi19-8009-e514-91897426g69","created_at":"2023-01-01T12:00:00Z","checklist":{"item1":"Check lighting","item2":"Verify textures"},"links":["https://example.com/reference1","https://example.com/reference2"]}]'

Request examples

[
  {
    "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "comment": "This looks great! Ready for review.",
    "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "object_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "created_at": "2023-01-01T12:00:00Z",
    "checklist": {
      "item1": "Check lighting",
      "item2": "Verify textures"
    },
    "links": [
      "https://example.com/reference1",
      "https://example.com/reference2"
    ]
  }
]

Response examples (201)

[
  {
    "id": "b35b7fb5-df86-5776-b181-68564193d36",
    "task_id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "person_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "comment": "This looks great! Ready for review.",
    "task_status_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "created_at": "2023-01-01T12:00:00Z"
  }
]

Delete project

DELETE /data/projects/{instance_id}

Jwt authorization

Delete a project by its ID. Only closed projects can be deleted. Returns empty response on success.

Path parameters

instance_id string(uuid) Required

Query parameters

force boolean

Force deletion with cascading removal

Responses

204

Project deleted successfully
400

Only closed projects can be deleted or integrity error

DELETE /data/projects/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get project statuses

GET /data/project-status

Jwt authorization

Retrieve all project statuses. Supports filtering via query parameters and pagination.

Query parameters

page integer

Page number for pagination
limit integer

Number of results per page
relations boolean

Whether to include relations

Responses

200 application/json

Project statuses retrieved successfully
One of:
array-1 array[object] object-2 object
Hide attributes Show attributes

data array[object]

total integer

nb_pages integer

limit integer

offset integer

page integer
400

Invalid filter format or query error

GET /data/project-status

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

Response examples (200)

[
  {}
]

{
  "data": [
    {}
  ],
  "total": 100,
  "nb_pages": 2,
  "limit": 50,
  "offset": 0,
  "page": 1
}

Update project status

PUT /data/project-status/{instance_id}

Jwt authorization

Update a project status with data provided in the request body. JSON format is expected.

Path parameters

instance_id string(uuid) Required

application/json

Body Required

name string
color string

Responses

200 application/json

Project status updated successfully
Hide response attributes Show response attributes object
- id string(uuid)
- name string
- color string
- created_at string(date-time)
- updated_at string(date-time)
400

Invalid data format or validation error

PUT /data/project-status/{instance_id}

curl \
 --request PUT 'http://api.example.com/data/project-status/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Closed","color":"#FF0000"}'

Request examples

{
  "name": "Closed",
  "color": "#FF0000"
}

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Closed",
  "color": "#FF0000",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}

Delete organisation

DELETE /data/organisations/{instance_id}

Jwt authorization

Delete an organisation by its ID. Returns empty response on success.

Path parameters

instance_id string(uuid) Required

Responses

204

Organisation deleted successfully
400

Integrity error or cannot delete

DELETE /data/organisations/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/organisations/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Delete preview file

DELETE /data/preview-files/{instance_id}

Jwt authorization

Delete a preview file by its ID. Returns empty response on success. May require force flag if file has associated data.

Path parameters

instance_id string(uuid) Required

Query parameters

force boolean

Force deletion even if file has associated data

Responses

204

Preview file deleted successfully
400

Integrity error or cannot delete

DELETE /data/preview-files/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/preview-files/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"

Get news

GET /data/news/{instance_id}

Jwt authorization

Retrieve a news entry by its ID and return it as a JSON object. Supports including relations.

Path parameters

instance_id string(uuid) Required

Query parameters

relations boolean

Whether to include relations

Responses

200 application/json

News entry retrieved successfully
Hide response attributes Show response attributes object
- id string(uuid)
- title string
- project_id string(uuid)
- content string
- created_at string(date-time)
- updated_at string(date-time)
400

Invalid ID format or query error

GET /data/news/{instance_id}

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

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "title": "Project Update",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "content": "News content text",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Update entity link

PUT /data/entity-links/{instance_id}

Jwt authorization

Update an entity link with data provided in the request body. JSON format is expected.

Path parameters

instance_id string(uuid) Required

application/json

Body Required

nb_occurences integer
label string

Responses

200 application/json

Entity link updated successfully
Hide response attributes Show response attributes object
- id string(uuid)
- entity_in_id string(uuid)
- entity_out_id string(uuid)
- nb_occurences integer
- label string
- created_at string(date-time)
- updated_at string(date-time)
400

Invalid data format or validation error

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" \
 --header "Content-Type: application/json" \
 --data '{"nb_occurences":2,"label":"updated"}'

Request examples

{
  "nb_occurences": 2,
  "label": "updated"
}

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "entity_in_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "entity_out_id": "c24a6ea4-ce75-4665-a070-57453082c25",
  "nb_occurences": 2,
  "label": "updated",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}

DELETE /data/studios/{instance_id}

Jwt authorization

Delete a studio by its ID. Returns empty response on success.

Path parameters

instance_id string(uuid) Required

Responses

204

Studio deleted successfully
400

Integrity error or cannot delete

DELETE /data/studios/{instance_id}

curl \
 --request DELETE 'http://api.example.com/data/studios/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"