Get, Update, or Delete Quest | AISquare Studio

curl -X PATCH /api/v1/quests/id/ \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": 42,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Advanced Data Science Quest",
  "player_level": {
    "id": 3,
    "uid": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "name": "Intermediate",
    "description": "Suitable for users with some experience in data science",
    "avg_score": 75
  },
  "metrics": "Completion rate: 85%, Average score: 78",
  "created_by": {
    "id": 7,
    "username": "datascientist_jane",
    "email": "jane.doe@aisquare.com",
    "full_name": "Jane Doe",
    "is_verified": true,
    "details": [
      {
        "profile_picture": "https://aisquare.com/profiles/jane_doe.jpg",
        "bio": "Data scientist with 10 years of experience in machine learning and AI.",
        "country": "USA",
        "phone": "+1-555-123-4567",
        "linkedin_url": "https://linkedin.com/in/janedoe",
        "github_url": "https://github.com/janedoe",
        "twitter_url": "https://twitter.com/janedoe",
        "website_url": "https://janedoe.com",
        "top_domain_elo": 2450.75,
        "top_domain_rank": 12
      }
    ],
    "followers_count": 1200
  },
  "created_at": "2023-11-20T14:45:00Z",
  "publication_url": "https://publication.aisquare.com/quests/advanced-data-science",
  "publication": {},
  "user_added_quest": true,
  "updated_at": "2024-04-10T10:15:00Z",
  "workspace_id": 5,
  "urls": [
    "https://aisquare.com/quests/advanced-data-science"
  ],
  "files": [
    "https://aisquare.com/resources/datascience-guide.pdf"
  ],
  "logo": "https://aisquare.com/assets/logos/ds-quest-logo.png",
  "cover": "https://aisquare.com/assets/covers/ds-quest-cover.jpg",
  "tags": [
    null
  ],
  "category": "Data Science",
  "subcategory": "Machine Learning",
  "focus_area": "Predictive Modeling",
  "visibility": "public",
  "summary": "A comprehensive quest to enhance your machine learning skills.",
  "description": "This quest covers advanced topics in data science including supervised and unsupervised learning techniques.",
  "co_creators": [
    null
  ],
  "creation_status": "in_progress"
}

Retrieves, updates, or deletes a specific quest by ID or UID.

Path parameters

idstringRequired

pkstringRequired

The ID or UID of the quest

Request

This endpoint expects an object.

namestringOptional<=255 characters

urlslist of stringsOptional

fileslist of strings or nullOptional

logostring or nullOptionalformat: "uri"

coverstring or nullOptionalformat: "uri"

tagslist of anyOptional

categorystringOptional

subcategorystringOptional

player_levelobjectOptional

Minimal serializer for PlayerLevel to be used in other modules

learningsany or nullOptional

quiz_formatany or nullOptional

focus_areastring or nullOptional<=256 characters

recommended_skillsany or nullOptional

List of recommended skills for this quest

visibilityenumOptional

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

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

Allowed values:

summarystring or nullOptional<=1024 characters

descriptionstring or nullOptional

co_creatorslist of anyOptional

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:

created_byobjectOptional

Response

Quest details

idintegerRead-only

uidstringRead-onlyformat: "uuid"

namestring<=255 characters

player_levelobject

Minimal serializer for PlayerLevel to be used in other modules

metricsstringRead-only

created_byobject

created_atdatetimeRead-only

publication_urlstring or nullRead-only

Get the publication URL from the quest's source experience

publicationmap from strings to any or nullRead-only

Get the publication from the quest's source experience

user_added_questbooleanRead-only

Check if the current user has added this quest

updated_atdatetimeRead-only

workspace_idintegerRead-only

urlslist of strings

fileslist of strings or null

logostring or nullformat: "uri"

coverstring or nullformat: "uri"

tagslist of any

categorystring

subcategorystring

learningsany or null

quiz_formatany or null

focus_areastring or null<=256 characters

recommended_skillsany or null

List of recommended skills for this quest

visibilityenum

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

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

Allowed values:

summarystring or null<=1024 characters

descriptionstring or null

co_creatorslist of any

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