Skip to main content

Create collection

POST 
/api/v1/collections

Create a new collection with the given name. The user creating the collection will be the owner of the collection. Additionally, if file IDs are provided in the request, they will be automatically added to the collection. Only file IDs from the creator's existing uploads can be used.

Request​

Body

    name stringrequired

    Possible values: non-empty

    Collection name

    file_ids string[]nullable

    Initial set of file IDs to include in the collection

    model stringnullable

    Possible values: [basilikum-minima, mate-meta, tortellini-maxima]

    Default value: basilikum-minima

    Indexing model to use for the collection

Responses​

Successful response

Schema

    result

    object

    required

    Collection details

    name stringrequired

    Collection name

    id stringrequired

    Collection ID

    created_at stringrequired

    Timestamp when the collection is created

Loading...