Create a study set
create_study_setCreate a flashcard set with 8-15 cards on a focused topic, publish it to the learner's Vocabit app, and receive a deep link for immediate access.
Instructions
Build a flashcard set and publish it to the learner's Vocabit app. Returns a deep link that opens the set on their device. Prefer one focused topic and 8-15 cards per set — long sets get abandoned. Use the notes field for what you want to check afterwards; the learner never sees it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cards | Yes | The flashcards, 1-300. Keep a set to one theme and around 8-15 cards for a single session | |
| notes | No | Your own notes about what to check when reviewing results. Never shown to the learner | |
| title | Yes | Set title as the learner will see it in the app | |
| topic | No | Topic tag used to group sets and to filter them later, e.g. 'church vocabulary' | |
| notify | No | Ping the learner on Telegram that the set is ready | |
| userId | No | Firebase UID of the learner. Omit to use the server default | |
| visibility | No | Defaults to private | |
| description | No | Short description shown under the title | |
| termLanguage | No | Language of the terms, e.g. 'de' | |
| definitionLanguage | No | Language of the definitions, e.g. 'en' |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| setId | Yes | ||
| title | Yes | ||
| userId | No | ||
| deepLink | Yes | Universal link that opens the set in the app | |
| notified | No | ||
| cardCount | Yes | ||
| visibility | No | ||
| appSchemeLink | No |