Manage Domains | AISquare Studio

import requests
url = "https://api.example.com/api/v1/qllm/domain/"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"domain_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"theme\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"summary\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"created_by\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"category\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subcategory\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"focus_area\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"visibility\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_draft\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"co_creators\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creation_status\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"saved\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metrics\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workspace_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"publication\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.patch(url, data=payload, headers=headers)
print(response.json())

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "domain_id": 42,
  "tags": [
    "machine-learning",
    "neural-networks",
    "nlp"
  ],
  "created_by": {
    "id": 101,
    "username": "jdoe",
    "email": "jdoe@example.com",
    "first_time_login": false,
    "profile_picture": "https://example.com/profiles/jdoe.jpg",
    "full_name": "John Doe",
    "theme": "dark",
    "is_superuser": false,
    "is_staff": true,
    "is_active": true,
    "is_verified": true
  },
  "category": "Technology",
  "subcategory": "Software",
  "co_creators": [
    {
      "id": 102,
      "username": "asmith",
      "email": "asmith@example.com",
      "first_time_login": false,
      "profile_picture": "https://example.com/profiles/asmith.jpg",
      "full_name": "Alice Smith",
      "theme": "light",
      "is_superuser": false,
      "is_staff": false,
      "is_active": true,
      "is_verified": true
    }
  ],
  "saved": true,
  "metrics": "user_engagement: high",
  "workspace_id": 7,
  "publication": {},
  "name": "Artificial Intelligence",
  "theme": "dark",
  "summary": "A domain focused on AI technologies and applications.",
  "description": "This domain covers various aspects of artificial intelligence including machine learning, neural networks, and natural language processing.",
  "logo": "https://example.com/images/ai_logo.png",
  "cover": "https://example.com/images/ai_cover.jpg",
  "focus_area": "Machine Learning and AI Research",
  "visibility": "public",
  "is_draft": false,
  "creation_status": "in_progress"
}

Provides CRUD operations for domains. GET: Retrieve domains with optional filtering by ID, tag, recommendations, category, subcategory, saved status, search, and sorting options. POST: Create a new domain (requires admin/developer permissions). PATCH: Update an existing domain (requires domain access). DELETE: Remove a domain (requires domain access).

Query parameters

categorystringOptional

Filter domains by category name.

idstringOptionalformat: "uuid"

Filter by domain UID.

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

Limit the number of random domains returned.

recently_viewedstringOptional

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

recommendedstringOptional

Flag to retrieve 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 a specific tag.

Request

This endpoint expects a multipart form.

idstringOptionalformat: "uuid"

domain_idintegerOptional

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)

tagslist of stringsOptional

created_byobjectOptional

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 nullOptional

subcategorystring or nullOptional

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

co_creatorslist of objectsOptional

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:

savedbooleanOptional

metricsstringOptional

workspace_idintegerOptional

publicationmap from strings to any or nullOptional

Response

Domain details or list of 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

403

Forbidden 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', ...]