Save/Unsave Domain | AISquare Studio

curl -X POST /api/v1/qllm/save-domain/ \
     -H "Content-Type: application/json" \
     -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_by": {
    "username": "johndoe",
    "email": "johndoe@example.com"
  },
  "co_creators": [
    {
      "username": "janedoe",
      "email": "janedoe@example.com"
    }
  ]
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "domain_id": 42,
  "tags": [
    "AI",
    "Machine Learning",
    "Data Science"
  ],
  "created_by": {
    "id": 101,
    "username": "johndoe",
    "email": "johndoe@example.com",
    "first_time_login": false,
    "profile_picture": "https://example.com/profiles/johndoe.jpg",
    "full_name": "John Doe",
    "theme": "dark",
    "is_superuser": false,
    "is_staff": true,
    "is_active": true,
    "is_verified": true
  },
  "category": "Technology",
  "subcategory": "Artificial Intelligence",
  "co_creators": [
    {
      "id": 102,
      "username": "janedoe",
      "email": "janedoe@example.com",
      "first_time_login": false,
      "profile_picture": "https://example.com/profiles/janedoe.jpg",
      "full_name": "Jane Doe",
      "theme": "light",
      "is_superuser": false,
      "is_staff": false,
      "is_active": true,
      "is_verified": true
    }
  ],
  "saved": true,
  "metrics": "active_users:150;projects:12",
  "workspace_id": 7,
  "publication": {},
  "name": "AI Research Domain",
  "theme": "dark",
  "summary": "A domain focused on advanced AI research and development.",
  "description": "This domain encompasses projects and collaborations related to artificial intelligence, machine learning, and data science.",
  "logo": "https://example.com/assets/logos/ai_research.png",
  "cover": "https://example.com/assets/covers/ai_research_cover.jpg",
  "focus_area": "Neural Networks and Deep Learning",
  "visibility": "public",
  "is_draft": false,
  "creation_status": "in_progress"
}

Provides endpoints to save, unsave, and list saved domains for the authenticated user. GET: List all saved domains. POST: Save a domain to user’s collection. DELETE: Remove a domain from user’s saved collection.

Request

This endpoint expects an object.

idstringRequiredformat: "uuid"

created_byobjectRequired

Mixin to handle profile_picture serialization for WebSocket compatibility.

This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers.

The mixin intelligently handles profile pictures from IAMUserDetail by:

Accessing the related details queryset on the IAMUser model
Extracting the ImageFieldFile from the first detail record
Converting it to a URL string for JSON serialization

Usage:

1 class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2     class Meta:
3         model = User
4         fields = ['id', 'username', 'profile_picture', ...]

Note:

This mixin expects the model to have a details related manager
The related detail should have a profile_picture ImageField
Returns None if no profile picture is found or an error occurs

Mixin to handle profile_picture serialization for WebSocket compatibility. This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers. The mixin intelligently handles profile pictures from IAMUserDetail by: 1. Accessing the related `details` queryset on the IAMUser model 2. Extracting the ImageFieldFile from the first detail record 3. Converting it to a URL string for JSON serialization Usage: ```python class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer): class Meta: model = User fields = ['id', 'username', 'profile_picture', ...] ``` Note: - This mixin expects the model to have a `details` related manager - The related detail should have a `profile_picture` ImageField - Returns None if no profile picture is found or an error occurs

co_creatorslist of objectsRequired

namestringOptional<=255 characters

themestringOptional<=64 characters

summarystring or nullOptional<=1024 characters

descriptionstring or nullOptional

logostring or nullOptionalformat: "uri"

Logo image for the domain (copied from experience)

coverstring or nullOptionalformat: "uri"

Cover image for the domain (copied from experience)

focus_areastring or nullOptional<=256 characters

visibilityenumOptional

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

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

Allowed values:

is_draftbooleanOptional

creation_statusenumOptional

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

* `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

Response

List of saved domains

idstringformat: "uuid"

domain_idintegerRead-only

tagslist of stringsRead-only

created_byobject

Mixin to handle profile_picture serialization for WebSocket compatibility.

This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers.

The mixin intelligently handles profile pictures from IAMUserDetail by:

Accessing the related details queryset on the IAMUser model
Extracting the ImageFieldFile from the first detail record
Converting it to a URL string for JSON serialization

Usage:

1 class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2     class Meta:
3         model = User
4         fields = ['id', 'username', 'profile_picture', ...]

Note:

This mixin expects the model to have a details related manager
The related detail should have a profile_picture ImageField
Returns None if no profile picture is found or an error occurs

categorystring or nullRead-only

subcategorystring or nullRead-only

co_creatorslist of objects

savedbooleanRead-only

metricsstringRead-only

workspace_idintegerRead-only

publicationmap from strings to any or nullRead-only

namestring<=255 characters

themestring<=64 characters

summarystring or null<=1024 characters

descriptionstring or null

logostring or nullformat: "uri"

Logo image for the domain (copied from experience)

coverstring or nullformat: "uri"

Cover image for the domain (copied from experience)

focus_areastring or null<=256 characters

visibilityenum

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

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

Allowed values:

is_draftboolean

creation_statusenum

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

* `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

Mixin to handle profile_picture serialization for WebSocket compatibility.

This mixin adds a SerializerMethodField for profile_picture that converts ImageFieldFile objects to URL strings, making them JSON serializable for WebSocket consumers.

The mixin intelligently handles profile pictures from IAMUserDetail by:

Accessing the related details queryset on the IAMUser model
Extracting the ImageFieldFile from the first detail record
Converting it to a URL string for JSON serialization

Usage:

1 class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2     class Meta:
3         model = User
4         fields = ['id', 'username', 'profile_picture', ...]

Note:

This mixin expects the model to have a details related manager
The related detail should have a profile_picture ImageField
Returns None if no profile picture is found or an error occurs

1	class MyUserSerializer(ProfilePictureMixin, serializers.ModelSerializer):
2	class Meta:
3	model = User
4	fields = ['id', 'username', 'profile_picture', ...]