List or Create Collections | AISquare Studio

curl -X POST /api/v1/collections/ \
     -H "Content-Type: application/json" \
     -d '{
  "name": "AI Innovations Collection",
  "publication_id": 42
}'

{
  "id": 101,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "AI Innovations Collection",
  "publication": {
    "id": 42,
    "uid": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "name": "Tech Insights Monthly",
    "custom_url": "tech-insights-monthly",
    "logo": "https://example.com/assets/logos/tech-insights-logo.png",
    "cover_image": "https://example.com/assets/covers/tech-insights-cover.jpg"
  },
  "tags": "AI, Machine Learning, Innovation",
  "experience_count": 12,
  "ordered_experiences": "[{\"experience_id\": 201, \"order\": 1}, {\"experience_id\": 202, \"order\": 2}, {\"experience_id\": 203, \"order\": 3}]",
  "metrics": "{\"views\": 1500, \"likes\": 300, \"shares\": 75}",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "owner": {
    "id": 7,
    "email": "jane.doe@example.com",
    "full_name": "Jane Doe",
    "username": "janedoe",
    "is_verified": true,
    "profile_picture": "https://example.com/profiles/janedoe.jpg"
  },
  "description": "A curated collection of the latest AI research and applications.",
  "visibility": "public"
}

GET: List all collections accessible to the user, ordered by creation date. POST: Create a new collection with ordered experiences. Only published experiences belonging to the same publication can be added.

Request

This endpoint expects an object.

namestringRequired<=60 characters

Collection title (max 60 characters)

publication_idintegerRequired

descriptionstringOptional<=500 characters

Collection description (max 500 characters)

tag_nameslist of stringsOptional

visibilityenumOptional

public - Public
private - Private
team - Team
org - Organization

* `public` - Public * `private` - Private * `team` - Team * `org` - Organization

Allowed values:

experienceslist of maps from strings to integersOptional

List of dicts with ‘experience_id’ and ‘order’ keys. Required for creation.

Response

List of collections

idintegerRead-only

uidstringRead-onlyformat: "uuid"

namestring<=256 characters

Collection name (max 60 characters)

publicationobject

Minimal serializer for Publication, used in other serializers

tagsstringRead-only

experience_countintegerRead-only

ordered_experiencesstringRead-only

metricsstringRead-only

created_atdatetimeRead-only

updated_atdatetimeRead-only

ownerobject

Simple user serializer with profile picture from associated IAMUserDetail.

Fields:

id, email, full_name, username, is_verified (from IAMUser)
profile_picture (from first related IAMUserDetail if present)

Simple user serializer with profile picture from associated IAMUserDetail. Fields: - id, email, full_name, username, is_verified (from IAMUser) - profile_picture (from first related IAMUserDetail if present)

descriptionstring<=512 characters

Collection description (max 500 characters)

visibilityenum

public - Public
private - Private
team - Team
org - Organization

* `public` - Public * `private` - Private * `team` - Team * `org` - Organization

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error