Recommend newCardsPerDay from a deadline

Routine read. Does not write. Given a deadline and card counts, returns recommended newCardsPerDay (ceil of remaining new cards ÷ study days through the deadline, clamped to 0–9999). There is no silent default of 20. This is new-card trickle math. Review load grows, so treat the number as a floor: Muse may raise N or negotiate more study time. Call this before createDeck when the person has a deadline, and again after bulk card adds. Send remainingNewCards, totalCards, or deckId. When deckId is set, remaining new cards and current N come from that owned deck unless you override them. Another token's deck is 404. Prefer a YYYY-MM-DD deadline so timezone does not shift the date. Create still requires an explicit newCardsPerDay; this call only helps you choose it.

post/plan/new-cards

Request

Base URL: https://fluidrecall.com/api/v1
URL: https://fluidrecall.com/api/v1/plan/new-cards
Auth: one of:
- HTTP bearer
- HTTP dpop

Request body

deadlinestring required

YYYY-MM-DD preferred. A UTC instant ending in Z is converted to the study day in timezone.

asOfstring

UTC ISO-8601 timestamp ending in Z

timezonestring

IANA name. Defaults to the account timezone.

dayBoundaryHourinteger

remainingNewCardsinteger

totalCardsinteger

alreadyLearnedinteger

skipWeekendsboolean

studyDaysPerWeekinteger

bufferStudyDaysinteger

Reserve this many study days at the end of the window as review-only buffer.

currentNewCardsPerDayinteger nullable

Compare this N to the recommendation. Omit to use the deck's effective N when deckId is set.

deckIdstring uuid

Fill remaining new cards and current N from this owned deck unless you override them.

Response

Recommended N, days remaining, projected finish, on-track, and coaching.

deadlinestring required

Deadline study day as YYYY-MM-DD.

asOfstring required

UTC ISO-8601 timestamp ending in Z

asOfStudyDaystring required

Study day of asOf as YYYY-MM-DD.

timezonestring required

dayBoundaryHourinteger required

remainingNewCardsinteger required

alreadyLearnedinteger required

totalCardsinteger required

calendarDaysUntilDeadlineinteger required

studyDaysUntilDeadlineinteger required

recommendedNewCardsPerDayinteger required

ceil(remainingNewCards / studyDaysUntilDeadline), clamped to 0–9999. Not a default of 20. A floor from the deadline.

currentNewCardsPerDayinteger nullable required

projectedFinishDateAtCurrentstring nullable required

YYYY-MM-DD of the last new-card introduction at the current N. Null if current N is missing or 0.

projectedFinishDateAtRecommendedstring nullable required

onTrackboolean nullable required

True when current N finishes remaining new cards by the deadline. Null when there is no current N.

countsFromDeckboolean required

appliedboolean required

deckIdstring uuid nullable required

deckobject nullable required

The patched deck after apply. Null on preview.

assumptionsstring[] required

coachingstring required

Changes

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