add_cards
ChatGPTAdd one or many cards, across any decks, in one call. A term already in the learner's decks is skipped, never rejected, and the result names the existing card. Say meaningSource "lesson" when the meaning is in the material, so the learner can tell it from text you composed. Empty fields stay empty unless a card sets enrich to true. Needs write.
archive_card
ChatGPTHide a card without destroying it. It leaves the deck and the review queue; restore_card brings it back with its schedule intact. Needs write.
archive_card_image
ChatGPTHide the card's picture. Picture review pauses with its schedule intact; restore_card_image brings both back. Needs write.
archive_cards
ChatGPTHide up to 200 cards in one call, each the way archive_card does. A card already archived is left as it is. Each card succeeds or fails on its own: one that is missing, refused or could not be saved comes back as an error with a code, and the rest are still archived. Outcomes come back in the same order. Needs write.
archive_deck
ChatGPTHide a deck. Its cards stay and leave the review queue with it; restore_deck brings it back. Needs write.
archive_section
ChatGPTHide a section. With cards "archive" its cards leave the deck and review with it; with "keep" they stay in the deck, without a section. Ask the learner which they want. restore_section undoes either. Needs write.
archive_tag
ChatGPTTake a tag off every card of one deck; other decks keep it. restore_tag puts it back on the same cards. Needs write.
create_deck
ChatGPTMake a new deck. Give it a default language so cards added without one inherit it, and a purpose when it is for a subject or exam rather than a language. Check list_decks first: a deck for this language or lesson may exist. Needs write.
create_section
ChatGPTMake a section, last in the deck, and optionally move cards of the deck into it. Check list_sections first: it may exist. Only the deck's owner can. Needs write.
create_series
ChatGPTMake a series, last in the learner's order, and optionally move their decks into it in the order given. Check list_series first: one may exist. Needs write.
delete_series
ChatGPTDelete a series. It is gone for good, so ask the learner first, and ask which they want for its decks: with decks "archive" they are archived with it, and with "keep" they stay in Library without a series. Either way the decks and their cards survive. Needs write.
describe_card_image
ChatGPTChange what the card's picture description says. Null removes it, which pauses picture review for the card. A description that contains the term or meaning is refused with description_reveals_answer. Needs write.
due_counts
ChatGPTHow many cards are waiting to be reviewed right now, in total, per deck and per series, and how many are in each Today round: forgotten today, new, and slipping (the first grade was Forgot on 3 of the card's last 5 review days before today). Only the learner can review them, in the app.
enrich_card
ChatGPTAsk Lymi to fill a card's empty meaning, example, pronunciation and language with AI, including fields cleared on purpose. The card comes back at enrichmentStatus "working"; read it with get_card to see the text land. A card with nothing left to fill is refused. Needs write.
get_card
ChatGPTOne card by id, with everything the learner wrote on it.
get_deck
ChatGPTOne deck's summary: its settings, how many active cards it has, how many are due now and how many are new, learning and known, and the term and meaning of its 15 newest cards. For every card with all its fields, page through search_cards with the deckId; to find one card, search by its term. list_sections has the deck's sections and how far the learner is in each.
get_insights
ChatGPTHow the learning is going: recall rate, days reviewed, cards by stage, the next seven days of due cards, and the cards that keep coming back. Days are bucketed in the timezone you pass.
get_settings
ChatGPTThe learner's settings: the language meanings are written in, and the daily goal in recall attempts, where every accepted grade counts, Forgot and repeated cards included.
get_streak
ChatGPTToday's attempts against the daily goal, days in a row whose goal was satisfied, the longest run, how many days had a review, the rest days that kept a run through one short day a week, and every day with an attempt. Days follow the learner's review timezone.
list_deck_tags
ChatGPTThe tags on a deck's active cards, with how many carry each, and the tags archived from it. Only the deck's owner can. To put tags on cards, send update_cards with each card's tags.
list_decks
ChatGPTEvery active deck with its card count and how many cards are due now, plus the language meanings are written in. Call this first: card adds need a deck id. Set archived to true to list archived decks instead, for example to find one to restore.
list_sections
ChatGPTA deck's sections in order, each with its card count and the learner's standing: open, ready or locked, with Known and not-started counts. progress names the section the learner is on and the next one. Set archived to true for archived sections.
list_series
ChatGPTThe learner's series in order, each with its decks in order and their card and due counts.
mention_search
ChatGPTDecks and cards whose name or text matches, for the learner to @-mention.
move_cards_to_section
ChatGPTPut up to 500 cards of one deck in a section, or take them out of theirs with sectionId null. Schedules and history stay. Sending the same move again changes nothing. Needs write.
open_lymi
ChatGPTLymi's home inside the assistant: what is due, per deck. The learner opens it from the sidebar or beside a conversation.
rename_section
ChatGPTGive a section a new name. Needs write.
rename_tag
ChatGPTRename a tag on one deck's cards; other decks keep it. A name the learner already uses merges the two. A change of case alone respells the tag in every deck. Needs write.
reorder_sections
ChatGPTPut a deck's active sections in a new order. List every one once; a list that no longer matches fails, so call list_sections again. Reordering never locks a section a learner opened. Needs write.
reorder_series
ChatGPTPut the learner's active series in a new order. List every one of them once; a list that no longer matches fails, so call list_series again. Needs write.
restore_card
ChatGPTBring an archived card back, schedule and all. Find archived cards with search_cards and archived set to true. Needs write.
restore_card_image
ChatGPTBring back the picture archived last, and picture review with it. Needs write.
restore_cards
ChatGPTBring back up to 200 archived cards in one call, each the way restore_card does. A card that is already active is left as it is. Each card succeeds or fails on its own: one that is missing, refused or could not be saved comes back as an error with a code, and the rest are still restored. Outcomes come back in the same order. Needs write.
restore_deck
ChatGPTBring an archived deck and its cards back. Needs write.
restore_section
ChatGPTBring an archived section back with the cards archived alongside it. Find archived sections with list_sections and archived set to true. Needs write.
restore_tag
ChatGPTPut an archived tag back on the cards of the deck it came off, in its place. A card that has twenty tags since stays without it. Needs write.
search_cards
ChatGPTFind cards by free text, or by a filter on any card field and on the learner's own review history. Filter fields combine with AND; use in for alternatives, as in sectionId: { in: [...] } or reviews.lastRating: { in: [1, 2] }. Dates take an ISO timestamp or a duration from now such as -P30D. The cards forgotten most in the last month: filter: { reviews: { since: "-P30D", lapses: { gte: 1 } } }, sort: [{ field: "lapses", direction: "desc" }], stats: true. Cards with an AI-written example: filter: { exampleSource: { eq: "ai" } }. stats adds each card's review record, overall and per review mode. Set archived to true to look through archived cards. Results come a page at a time: pass nextCursor as cursor. A page can be short or even empty; keep going until nextCursor is null. total is null when it is not known exactly.
set_card_image
ChatGPTGive a card its one picture, replacing any it has. Send a public http or https url, or base64 data. Lymi stores a private, normalized copy and never shows the link. JPEG, PNG, WebP and still GIF up to 10 MB; SVG and animation are refused. Pass the card's imageVersion as version so a newer change is not overwritten. A description that contains the term or meaning is refused with description_reveals_answer and the text it matched. Needs write.
settings_read
ChatGPTThe settings ChatGPT shows on Lymi's plugin page.
settings_update
ChatGPTSaves a setting the learner changed on Lymi's plugin page.
update_card
ChatGPTChange fields on one card. Send only what changes; a field left out keeps its text. A meaning or example you change becomes the learner's unless you say it came from the lesson. Setting deckId moves the card. Needs write.
update_cards
ChatGPTChange fields on up to 200 cards in one call, each with its cardId and only the fields that change, by the same rules as update_card. Each card succeeds or fails on its own: one that is missing, refused or could not be saved comes back as an error with a code, and the rest still change. Outcomes come back in the same order. Needs write.
update_deck
ChatGPTRename a deck, change its description, default language, purpose or review modes, or move it into or out of a series with seriesId. Send only what changes. Needs write.
update_series
ChatGPTRename a series, or set every deck it holds in order. A deck listed from elsewhere moves in; one left out goes back to the learner's other decks. Sending the same list again changes nothing. Needs write.
update_settings
ChatGPTChange the app language, which also sets the language meanings are written in. Cards already written are not translated. Needs write.