Get, Update, or Delete Quest | AISquare Studio

curl /api/v1/quests/id/ \
     -H "Content-Type: application/json"

{
  "id": 42,
  "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Mastering Data Structures",
  "player_level": {
    "id": 3,
    "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Intermediate",
    "description": "Suitable for learners with basic programming knowledge",
    "avg_score": 75
  },
  "metrics": "Completion rate: 68%, Average score: 82%",
  "created_by": {
    "id": 5,
    "username": "bob_creator",
    "email": "bob.creator@aisquare.com",
    "full_name": "Bob Smith",
    "is_verified": true,
    "details": [
      {
        "profile_picture": "https://aisquare.com/profiles/bob.jpg",
        "bio": "Content creator and quest designer.",
        "country": "Canada",
        "phone": "+1-555-987-6543",
        "linkedin_url": "https://linkedin.com/in/bobsmith",
        "github_url": "https://github.com/bobsmith",
        "twitter_url": "https://twitter.com/bob_creator",
        "website_url": "https://bobsmith.io",
        "top_domain_elo": 1400,
        "top_domain_rank": 58
      }
    ],
    "followers_count": 850
  },
  "created_at": "2024-01-15T09:30:00Z",
  "publication_url": "https://publication.aisquare.com/quests/42",
  "publication": {
    "publisher": "AISquare Publishing",
    "published_date": "2024-01-20",
    "version": "1.0"
  },
  "user_added_quest": true,
  "updated_at": "2024-04-10T15:45:00Z",
  "workspace_id": 12,
  "urls": [
    "https://aisquare.com/quests/mastering-data-structures"
  ],
  "files": [
    "https://aisquare.com/resources/data-structures-guide.pdf"
  ],
  "logo": "https://aisquare.com/assets/logos/data-structures.png",
  "cover": "https://aisquare.com/assets/covers/data-structures-cover.jpg",
  "tags": [
    "programming",
    "algorithms",
    "data-structures"
  ],
  "category": "Computer Science",
  "subcategory": "Algorithms",
  "focus_area": "Algorithm Optimization",
  "recommended_skills": [
    "Problem Solving",
    "Programming Logic",
    "Complexity Analysis"
  ],
  "visibility": "public",
  "summary": "An in-depth quest to master fundamental data structures and their applications.",
  "description": "This quest covers arrays, linked lists, trees, graphs, and hash tables with practical coding challenges.",
  "co_creators": [
    {
      "id": 7,
      "username": "alice_dev",
      "email": "alice.dev@aisquare.com",
      "full_name": "Alice Johnson",
      "is_verified": true,
      "details": [
        {
          "profile_picture": "https://aisquare.com/profiles/alice.jpg",
          "bio": "Software engineer and educator specializing in algorithms.",
          "country": "USA",
          "phone": "+1-555-123-4567",
          "linkedin_url": "https://linkedin.com/in/alicejohnson",
          "github_url": "https://github.com/alicejohnson",
          "twitter_url": "https://twitter.com/alice_dev",
          "website_url": "https://alicejohnson.dev",
          "top_domain_elo": 1520.5,
          "top_domain_rank": 42
        }
      ],
      "followers_count": 1200
    }
  ],
  "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

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