Get, Update, or Delete Collection | AISquare Studio

import requests
url = "https://api.example.com/api/v1/collections/1/"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": 1,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Spring Travel Adventures",
  "publication": {
    "id": 12,
    "uid": "7b9e8f2a-4d3c-4f1a-9b2e-8f7a9c3d2b1e",
    "name": "Wanderlust Magazine",
    "custom_url": "wanderlust-magazine",
    "logo": "https://example.com/assets/logos/wanderlust-logo.png",
    "cover_image": "https://example.com/assets/covers/spring-travel-cover.jpg"
  },
  "owner": {
    "id": 42,
    "email": "jane.doe@example.com",
    "full_name": "Jane Doe",
    "username": "janedoe",
    "is_verified": true,
    "profile_picture": "https://example.com/profiles/janedoe.jpg"
  },
  "tags": "travel, spring, adventure, 2024",
  "ordered_experiences": "[{\"experience_id\": 101, \"order\": 1}, {\"experience_id\": 102, \"order\": 2}, {\"experience_id\": 103, \"order\": 3}]",
  "experience_count": 3,
  "metrics": "{\"views\": 1520, \"likes\": 340, \"shares\": 75}",
  "user_interaction_state": "{\"liked\": true, \"bookmarked\": false}",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "description": "A curated collection of immersive travel experiences for spring 2024.",
  "visibility": "public"
}

GET: Retrieve detailed information about a collection including ordered experiences. PUT/PATCH: Update collection details and/or ordered experiences. DELETE: Delete a collection. Only the owner can update or delete.

Path parameters

idintegerRequired

pkintegerRequired

The ID of the collection

Request

This endpoint expects an object.

namestringOptional<=60 characters

Collection title (max 60 characters)

descriptionstringOptional<=500 characters

Collection description (max 500 characters)

publication_idintegerOptional

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

Collection details

idintegerRead-only

uidstringRead-onlyformat: "uuid"

namestring<=256 characters

Collection name (max 60 characters)

publicationobject

Minimal serializer for Publication, used in other serializers

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)

tagsstringRead-only

ordered_experiencesstringRead-only

experience_countintegerRead-only

metricsstringRead-only

user_interaction_statestringRead-only

created_atdatetimeRead-only

updated_atdatetimeRead-only

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

403

Forbidden Error

404

Not Found Error