Retrieve, Update, or Delete Experience | AISquare Studio

curl -X PUT /api/v1/experiences/1/ \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 1,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "AI-Powered Content Creation",
  "experience_title": "Mastering AI Content Generation",
  "experience_description": "An in-depth guide on leveraging AI tools to create engaging and effective content.",
  "logo_url": "https://example.com/assets/logos/ai-content-logo.png",
  "cover_url": "https://example.com/assets/covers/ai-content-cover.jpg",
  "rag_documents": [
    101,
    102
  ],
  "category": "Technology",
  "subcategory": "Artificial Intelligence",
  "tags": [
    "AI",
    "Content Marketing",
    "Automation"
  ],
  "is_fully_published": true,
  "publication": "Spring 2024 Edition",
  "publication_details": "Published in the April 2024 issue of Tech Innovators Magazine.",
  "experience_types_data": [
    {
      "experience_type": "AI_EXPERT",
      "logo_url": "https://example.com/assets/logos/ai-expert.png",
      "cover_url": "https://example.com/assets/covers/ai-expert-cover.jpg"
    }
  ],
  "experience_types": [
    "AI_EXPERT"
  ],
  "has_published_versions": true,
  "publishing_status": "completed",
  "generation_ready_for_review": true,
  "blog_id": "blog-2024-ai-content",
  "podcast_script_preview": "Welcome to the AI Content Creation podcast, where we explore the latest in AI-driven marketing strategies...",
  "metrics": {},
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-04-10T14:45:00Z",
  "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"
  },
  "focus_area": "Content Creation",
  "visibility": "public",
  "status": "in_progress",
  "is_draft": false,
  "step": 3,
  "needs_review": false,
  "primary_deployed_resource_uid": "7e57d004-2b97-0e7a-b45f-5387367791cd",
  "primary_deployed_resource_id": 55,
  "primary_deployed_resource_type": "AI Expert"
}

Retrieve a specific experience by ID, update it, or delete it. Returns detailed information including all experience type data. Users can only access their own experiences or public ones.

Category, Subcategory and Tags Support: When updating, you can specify category and subcategory using their names directly. Tags can be provided as a list of strings and will be created if they don’t exist. The system will automatically resolve names to the corresponding objects.

Retrieve a specific experience by ID, update it, or delete it. Returns detailed information including all experience type data. Users can only access their own experiences or public ones. **Category, Subcategory and Tags Support:** When updating, you can specify category and subcategory using their names directly. Tags can be provided as a list of strings and will be created if they don't exist. The system will automatically resolve names to the corresponding objects.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

titlestring or nullOptional<=255 characters

rag_documentslist of integersOptional

content_vault_documentslist of integersOptional

List of content vault document IDs to link to this experience

categorystring or nullOptional

Category name

subcategorystring or nullOptional

Subcategory name

focus_areastring or nullOptional

tagslist of stringsOptional

List of tag names (will be created if they don’t exist)

visibilityenumOptional

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

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

Allowed values:

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:

is_draftbooleanOptional

stepinteger or nullOptional-2147483648-2147483647

publicationinteger or nullOptional

Single publication ID to link to the experience

needs_reviewbooleanOptional

Whether this experience requires review before publishing

experience_types_datalist of objectsOptional

selected_experience_typeslist of enumsOptional

List of experience types to include

Allowed values:

Response

Experience details or updated experience

idintegerRead-only

uidstringRead-onlyformat: "uuid"

titlestringRead-only

experience_titlestringRead-only

experience_descriptionstringRead-only

Get the description of the primary deployed resource. Returns empty string if not published or resource not found.

logo_urlstringRead-only

cover_urlstringRead-only

rag_documentslist of integersRead-only

categorystring or nullRead-only

subcategorystring or nullRead-only

tagslist of stringsRead-only

is_fully_publishedbooleanRead-only

True when all selected experience types have been successfully published

publicationstringRead-only

publication_detailsstringRead-only

experience_types_datalist of objectsRead-only

experience_typeslist of stringsRead-only

Get all experience types associated with this experience

has_published_versionsbooleanRead-only

Check if this experience has any published versions.

publishing_statusstringRead-only

Get the current publishing status of the experience.

generation_ready_for_reviewbooleanRead-only

Check if deployed AI Notes and Podcasts have completed generation.

blog_idstringRead-only

podcast_script_previewstringRead-only

metricsmap from strings to anyRead-only

Get metrics for the primary deployed resource. Returns default metrics if not published.

created_atdatetimeRead-only

updated_atdatetimeRead-only

ownerobject

Owner/uploader user object

focus_areastring or null

visibilityenum

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

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

Allowed values:

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:

is_draftboolean

stepinteger or null-2147483648-2147483647

needs_reviewboolean

Whether this experience requires review before publishing

primary_deployed_resource_uidstring or nullformat: "uuid"

UID of the primary deployed resource (domain/blog/quest/podcast)

primary_deployed_resource_idinteger or null-2147483648-2147483647

Database ID of the primary deployed resource

primary_deployed_resource_typestring or null<=20 characters

Type of the primary deployed resource (AI Expert/AI Note/Quest/Podcast)

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error