Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
title
required

Title

Validations:

  • Must be a String

description
optional

Description

Validations:

  • Must be a String

category
optional

Category

Validations:

  • Must be a String

tags
optional

Tags

Validations:

  • Must be an array of String

Examples

// Successful request
POST /api/v2/collections
{
  "title": "Test Collection",
  "description": "Test description"
}
200
{
  "collection": {
    "id": "Mmt55dqXeNE5xxRUvkQh",
    "title": "Test Collection",
    "description": "Test description",
    "category": null,
    "tags": [],
    "owner": "admin-user-47@example.com",
    "media_type": "collection",
    "isPublic": false,
    "created_date": "2023-11-27T09:42:47.546Z",
    "modification_date": "2023-11-27T09:42:47.546Z",
    "original_title": "Test Collection"
  }
}
// Failed request
POST /api/v2/collections
{
  "title": "Testing too long title: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "description": "Test description"
}
400
{
  "error": "Title is too long (maximum is 255 characters)"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters