List domains | AISquare Studio

curl /api/v1/qllm/domain/ \
     -H "Content-Type: application/json"

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "domain_id": 42,
    "tags": [
      "machine-learning",
      "deep-learning",
      "nlp"
    ],
    "created_by": {
      "id": 101,
      "username": "jatin_saini",
      "email": "jatin@opengrowth.com",
      "first_time_login": false,
      "profile_picture": "https://example.com/profiles/jatin_saini.jpg",
      "full_name": "Jatin Saini",
      "theme": "light",
      "is_superuser": false,
      "is_staff": true,
      "is_active": true,
      "is_verified": true
    },
    "category": "Technology",
    "subcategory": "Software Development",
    "co_creators": [
      {
        "id": 102,
        "username": "alice_wong",
        "email": "alice.wong@example.com",
        "first_time_login": false,
        "profile_picture": "https://example.com/profiles/alice_wong.png",
        "full_name": "Alice Wong",
        "theme": "dark",
        "is_superuser": false,
        "is_staff": false,
        "is_active": true,
        "is_verified": true
      }
    ],
    "saved": true,
    "metrics": "{\"users\": 1200, \"active_projects\": 35}",
    "workspace_id": 7,
    "publication": {
      "published_at": "2024-05-10T09:00:00Z",
      "version": "1.3.0"
    },
    "name": "Artificial Intelligence",
    "theme": "dark",
    "summary": "Explore the latest advancements and applications in AI technology.",
    "description": "This domain covers machine learning, neural networks, natural language processing, and AI ethics.",
    "logo": "https://example.com/assets/logos/ai_logo.png",
    "cover": "https://example.com/assets/covers/ai_cover.jpg",
    "focus_area": "AI Research and Development",
    "visibility": "public",
    "is_draft": false,
    "creation_status": "completed"
  }
]

Get domains with optional filtering by ID, tag, recommendations, category, subcategory, saved status, search, and sorting options

Query parameters

categorystringOptional

Filter domains by category name

idstringOptional

Domain ID to retrieve specific domain

most_popularstringOptional

Sort domains by popularity (number of users). Mutually exclusive with other sorting options

most_recentstringOptional

Sort domains by creation date (most recent first). Mutually exclusive with other sorting options

nintegerOptional

Number of domains to return

recently_viewedstringOptional

Sort domains by last update date (most recently updated first). Mutually exclusive with other sorting options

recommendedstringOptional

Get recommended domains

savedstringOptional

Filter to show only saved domains (requires authentication)

searchstringOptional

Search across domain name, summary, description, creator usernames, and tag names

subcategorystringOptional

Filter domains by subcategory name

tagstringOptional

Filter domains by tag

Response

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

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

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