Concepts

At its core, the EveryPoint API allows you to store and retrieve data, share data with other EveryPoint users, and perform operations on that data. For instance, you might upload a set of images, combine them with ones that were shared with you from another user, request that the combined set of images be turned into a 3D textured mesh, and then download the resulting mesh for viewing on your device.

In the API, individual files are referred to by their type, such as image, video, or mesh. Once a set of files are available in the API, operations can be performed on them, where an operation is called a function. When a function is paired with input files, optionally provided with settings, and queued for processing, that combination is called a job. Upon a job's completion, the job will contain references to its output files, and those files will also be available in the API. Operations can also be performed automatically through the use of triggers, where the occurrence of a particular event can cause an action to be executed.

To provide indexing and search capabilities, attributes can be assigned to files and jobs. To add semantic information, annotations can be created to label parts of a file. For organization, groups of files can be assigned to folders, which can then be shared with other EveryPoint users. To further organize and segment data, instances can be used to divide data into separate spaces.

For more details on how these concepts are applied in the API, refer to the API endpoints overview.