Index Collection Resource

Definition

This is an object representing a collection of indexed identities.

ENDPOINTS

GET /v1/index-collection/

GET /v1/index-collection/{COLLECTION_NAME}/

POST /v1/index-collection/

PUT /v1/index-collection/

DELETE /v1/index-collection/{COLLECTION_NAME}/

Attributes

Top level attributes

Name	Type	Description
name	string	Name of the Index Collection
description	string	Description or notes of the Index Collection
type	string	The type of the Index Collection
is_public	bool	Whether the Index Collection is publicly avaible or not
time_created	string	Creation time of the Index Collection (ISO Time String)
time_updated	string	Modification time of the Index Collection (ISO Time String)

Available Index Collection types

Type	Description
face	Indexing faces.

JSON Example

The following JSON snippet is showing an Index Collection object.

{
    "name": "default_index",
    "description": "",
    "type": "face",
    "is_public": false,
    "time_created": "2020-12-10 18:30:39.892000",
    "time_updated": "2020-12-10 18:30:39.892000"
}