List or Create Collections

POST

https://host.com/api/v1/collections/

POST

/api/v1/collections/

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

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

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

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)

descriptionstring<=512 characters

Collection description (max 500 characters)

visibilityenum

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

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error