Create an entity

Learn about the CreateEntities endpoint in the DestinationEntity collection.

Affective Computing (powered by Virtue) supports two types of entities; 3D environments and VHs.

This API enables you to create a new entity of either type.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Parameters

Parameter	Description
destination_Entity_Types_Id	Unique identifier that represents the entity type. This parameter can have the following values: ID Name Description 1 NPC Represents Virtual Human entities. 2 3DEnvironment Represents environment entities.
tenantId	Unique identifier of the tenant responsible for the project.
project_Domain_Id	Unique identifier of the project's domain. Note: Whether or not you need to enter the project domain ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values: ID Domain -1 No Domain 2 Security & Safety 3 Human wellbeing 4 Digital user experience
project_Function_Id	Unique identifier of the project's function based on the project's domain. Note: Whether or not you need to enter the project function ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values: For No domain (when project_Domain_Id is -1) ID Function Motivation -1 No Function - For Security & Safety (when project_Domain_Id is 2) ID Function Motivation 1 Anticipation of drivers' distraction Imposed 2 Employees' malicious patterns prediction (i.e. security staff of jewellery, bank, etc.) Free 3 Autonomous digital assistant to access and support safety & security operators duties Imposed 4 Detection of potential user malicious psychological profile (i.e. before flight onboarding) Free For Human wellbeing (when project_Domain_Id is 3) ID Function Motivation 5 Work out personalization Free 6 High-performance athlete's training personalization Imposed 7 Real-time and historical data of the psychological well being of the employee Free 8 Users' psychological assessments in real-time (i.e. digital psychologist Free For Digital user experience (project_Domain_Id is 4) ID Function Motivation 9 Irony detection Free 10 Music personalisation by emotions Imposed 11 Marketplace recommendations Free 12 Virtual soul recreation (i.e. personality) for bots and iNFT Free 13 Neuro-architecture Free
entityList	An array that contains the following details of the entity: Parameter Description name Name of the entity. description An explanation of what the entity is. identifier A unique identifying label for the entity, for reference.