Create a deck

Write. Create one deck. The response id is what later calls use. Do not key off the name. newCardsPerDay is required. Omit it, or send null, and the call is 400. When the person has a deadline, call previewDeadlinePlan first and send that recommended integer or a higher one you negotiated. Choose newCardsPerDay with the person for this deck. There is no default of 20. When they have a deadline, call previewDeadlinePlan first: it returns ceil(remaining new cards / study days) as a floor. Weigh study time (more time, a higher number), that deadline floor, and card complexity (tiny facts such as times tables can be higher; a beefy card such as the five steps of a cycle must be lower). You may raise N above the floor or negotiate more study time. Send that integer. After bulk card adds, re-run previewDeadlinePlan with that deckId and consider applyDeadlinePlan or updateDeck. 0 introduces no new cards unless the caller asks for extras. The maximum is 9999.

post/decks

Request

  • Base URL: https://fluidrecall.com/api/v1
  • URL: https://fluidrecall.com/api/v1/decks
  • Auth: one of:
    • HTTP bearer
    • HTTP dpop

Request body

namestring required
descriptionstring nullable
deckNotestring nullable

Optional coaching instructions for agents on this deck. Null clears it on later PATCH. Coaching notes are instructions for how an agent should quiz and coach. They are not the answer, not graded content, and not the quiz prompt. A deck note applies to every card in that deck. A card note is optional and additive with the deck note. Retrieve responses (listDue, upcoming-new, inventory, getCard, reveal, and agent session start/next/grade) include deckNote and cardNote so one call carries coaching context. Scripture / dictation: The learner needs every word remembered correctly, but often answers via dictation where punctuation gets messy. They set a deck note instructing the agent to check every word exactly, but not fail on punctuation differences, and to include that reason when coaching. This is only an example — notes can be any coaching preference for how agents should quiz/coach for that deck (or a specific card).

newCardsPerDayinteger required

Required. The integer you and the person chose for this deck. There is no default. 0 introduces no new cards unless the caller asks for extras.

Response

The created deck.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.