API Documentation
Account
- Create account
- Sign in
Card management
- Create flashcard
- Create folder
- Get all cards
- Get flashcard
- Get flashcard item
- Get today cards
- Move flashcard set
- Search
- Import flashcard
- Import from quizlet
- Import Anki Flashcards
Goals
- Create card goal
- Create xp goal
- Edit card goal
- Create xp goal
- Update goal status
- Delete goal
Statistics
- Calculate streak
- Get heatmap
- Update heatmap
Quests
- Get quests
- Create quest
- Delete quest
- Update quest progress
- Invite to quest
- Update invite status
Create quest
Create Quest
Create a new quest and add the user as a participant(owner from the quest).
POST
/
create-quest
Copy
curl --request POST \
--url http://dolphinflashcards.com/api/create-quest \
--header 'Content-Type: application/json' \
--data '{
"jwtToken": "<string>",
"deadline": "2023-11-07T05:31:56Z",
"questType": "cards_revised",
"questSubType": "monthly",
"quantity": 123
}'
Copy
{
"message": "Quest created successfully",
"quest": {
"quest_id": "<string>",
"title": "<string>",
"deadline": "2023-11-07T05:31:56Z",
"quest_type": "<string>",
"quest_sub_type": "<string>",
"quantity": 123,
"progress": 123,
"participants": [
{
"user_id": "<string>",
"status": "<string>",
"progress": 123,
"isOwner": true
}
]
}
}
Body
application/json
Response
200
application/json
Quest created successfully.
The response is of type object
.
Copy
curl --request POST \
--url http://dolphinflashcards.com/api/create-quest \
--header 'Content-Type: application/json' \
--data '{
"jwtToken": "<string>",
"deadline": "2023-11-07T05:31:56Z",
"questType": "cards_revised",
"questSubType": "monthly",
"quantity": 123
}'
Copy
{
"message": "Quest created successfully",
"quest": {
"quest_id": "<string>",
"title": "<string>",
"deadline": "2023-11-07T05:31:56Z",
"quest_type": "<string>",
"quest_sub_type": "<string>",
"quantity": 123,
"progress": 123,
"participants": [
{
"user_id": "<string>",
"status": "<string>",
"progress": 123,
"isOwner": true
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.