Using the API
The API is exclusively available to users with an active premium subscription. After
upgrading your account, you will receive a unique API key. All endpoints require a
valid account_api_key and email in the request body. You can
find your API key in your user account settings under the "API" tab.
account_api_key Your unique API key from account settings.
email The email associated with your account.
title Title for the created activity.
language Locale code (e.g. "en", "nl"). Defaults to your account language.
settings Endpoint-specific configuration.
Items
Most endpoints accept an items array in the request body. The structure
of each item depends on the activity type. Below are the common item formats.
Word Item
Used by Crossword, Acrostic, Word Scramble, Wordle, Wordseeker, Hangman, and more.
{
"answer": "BANANA",
"description": "A long yellow fruit",
"type": "text"
}Card Item
Used by Matching Pairs, Memory, and Flash Cards.
{
"cards": [
{
"type": "text",
"value": "Apple"
},
{
"type": "text",
"value": "A red fruit"
}
]
}Quiz Item
Used by Quiz and Board Game. Supports multiple_choice and open_answer types.
{
"question_type": "multiple_choice",
"description": "Which fruit is yellow?",
"answers": [
{
"type": "text",
"description": "Banana",
"isCorrect": true
},
{
"type": "text",
"description": "Strawberry",
"isCorrect": false
}
]
}Category Item
Used by Categorize.
{
"name": "Red Fruits",
"cards": [
{
"type": "text",
"value": "Strawberry"
},
{
"type": "text",
"value": "Cherry"
}
]
}Cryptogram Item
Used by Cryptogram.
{
"text": "An apple a day keeps the doctor away",
"author": "Proverb"
}