List or Create Quests

POST

https://host.com/api/v1/quests/

POST

/api/v1/quests/

$ curl -X POST /api/v1/quests/ \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Advanced Data Science Quest"
> }'

1 {
2   "id": 42,
3   "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "name": "Advanced Data Science Quest",
5   "player_level": {
6     "id": 3,
7     "uid": "7b9e1f2a-4d3b-4f9a-9c2e-1a2b3c4d5e6f",
8     "name": "Intermediate",
9     "description": "Suitable for learners with some experience in data science.",
10     "avg_score": 75
11   },
12   "metrics": "Completion rate: 85%, Average score: 78",
13   "created_by": {
14     "id": 101,
15     "username": "datascientist_jane",
16     "email": "jane.doe@aisquare.com",
17     "full_name": "Jane Doe",
18     "is_verified": true,
19     "details": [
20       {
21         "profile_picture": "https://aisquare.com/profiles/jane_doe.jpg",
22         "bio": "Data Scientist with 10 years of experience in machine learning and AI.",
23         "country": "USA",
24         "phone": "+1-555-123-4567",
25         "linkedin_url": "https://linkedin.com/in/janedoe",
26         "github_url": "https://github.com/janedoe",
27         "twitter_url": "https://twitter.com/janedoe",
28         "website_url": "https://janedoe.com",
29         "top_domain_elo": 2450.75,
30         "top_domain_rank": 12
31       }
32     ],
33     "followers_count": 3500
34   },
35   "created_at": "2024-01-15T09:30:00Z",
36   "publication_url": "https://publication.aisquare.com/quests/advanced-data-science",
37   "publication": {},
38   "user_added_quest": true,
39   "updated_at": "2024-01-15T09:30:00Z",
40   "workspace_id": 7,
41   "urls": [
42     "https://aisquare.com/quests/advanced-data-science"
43   ],
44   "files": [
45     "https://aisquare.com/resources/ds_quest_guide.pdf"
46   ],
47   "logo": "https://aisquare.com/assets/logos/ds_quest_logo.png",
48   "cover": "https://aisquare.com/assets/covers/ds_quest_cover.jpg",
49   "tags": [
50     null
51   ],
52   "category": "Data Science",
53   "subcategory": "Machine Learning",
54   "focus_area": "Predictive Modeling",
55   "visibility": "public",
56   "summary": "A comprehensive quest to master advanced data science techniques.",
57   "description": "This quest covers advanced topics in data science including machine learning algorithms, data preprocessing, and model evaluation.",
58   "co_creators": [
59     null
60   ],
61   "creation_status": "not_started"
62 }

Lists all quests or creates a new quest.

Request

This endpoint expects an object.

namestringRequired<=255 characters

player_levelobjectRequired

Minimal serializer for PlayerLevel to be used in other modules

created_byobjectRequired

urlslist of stringsOptional

fileslist of strings or nullOptional

logostring or nullOptionalformat: "uri"

coverstring or nullOptionalformat: "uri"

tagslist of anyOptional

categorystringOptional

subcategorystringOptional

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

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

Allowed values:

Response

List of quests

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

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

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error