Skip to main content
WaniKani logo
  • Category: education
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: WANIKANI
  • Version: 20261101_00

Tools

Slug: WANIKANI_CREATE_STUDY_MATERIALCreate the sole study-material record for a subject, optionally with notes or meaning synonyms. WaniKani provides no delete endpoint, so creation cannot be undone through the API.

Input Parameters

integer
required
Subject that does not already have a study-material record.
string
Optional personal note about the subject’s meaning.
string
Optional personal note about the subject’s reading.
array
Optional personal meaning synonyms to accept as correct answers.
boolean
required
Must be true to acknowledge that the created record cannot be deleted through the WaniKani API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_ASSIGNMENTSRetrieve one assignment by ID, or list the connected user’s assignments using progress, availability, level, subject, and update filters.

Input Parameters

array
Assignment IDs to include in a list query.
boolean
Filter by whether the assignment is burned.
boolean
Filter by whether the subject is hidden.
array
WaniKani levels to include (each 1-60).
boolean
Filter by whether the lesson assignment has started.
boolean
Filter by whether the assignment is unlocked.
boolean
Filter by whether the assignment has entered reviews.
array
SRS stages to include (each 0-9).
string
Opaque forward cursor returned by a previous call.
array
Subject IDs whose assignments should be returned.
integer
Assignment ID to retrieve directly. When set, omit all list filters and next_cursor.
array
Subject types to include.
string
Return assignments updated after this ISO-8601 time.
string
Return assignments available at or after this ISO-8601 time.
string
Return assignments available at or before this ISO-8601 time.
boolean
Filter to assignments currently available for review.
boolean
Filter to assignments currently available for lessons.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_LEVEL_PROGRESSIONSRetrieve one level-progression record by ID, or list the user’s level history with ID and update-time filters.

Input Parameters

array
Level-progression IDs to include.
string
Opaque forward cursor returned by a previous call.
string
Return records updated after this ISO-8601 time.
integer
Record ID to retrieve directly. When set, list filters and next_cursor must be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_RESETSRetrieve one account-reset record by ID, or list account level-reset history.

Input Parameters

array
Reset IDs to include.
integer
Reset record ID to retrieve directly. When set, list filters and next_cursor must be omitted.
string
Opaque forward cursor returned by a previous call.
string
Return reset records updated after this ISO-8601 time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_REVIEWSLook up a completed WaniKani review by ID or list reviews filtered by review IDs, subject IDs, or update time. DEPRECATED: WaniKani no longer stores review data, so lists are empty and individual lookups return not found.

Input Parameters

array
Review IDs to include.
integer
Completed review ID to retrieve directly. When set, list filters and next_cursor must be omitted.
string
Opaque forward cursor returned by a previous call.
array
Subject IDs whose reviews should be returned.
string
Return reviews updated after this ISO-8601 time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_REVIEW_STATISTICSRetrieve one per-subject review statistic by ID, or list answer totals, streaks, and accuracy using subject and percentage filters.

Input Parameters

array
Statistic record IDs to include.
boolean
Filter by whether the subject is hidden.
string
Opaque forward cursor returned by a previous call.
array
Subject IDs whose statistics should be returned.
array
Subject types to include.
string
Return statistics updated after this ISO-8601 time.
integer
Statistic record ID to retrieve directly. When set, list filters and next_cursor must be omitted.
integer
Return percentages strictly less than this value.
integer
Return percentages strictly greater than this value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_SPACED_REPETITION_SYSTEMSRetrieve one spaced-repetition system by ID, or list SRS definitions and their stage intervals.

Input Parameters

array
SRS definition IDs to include.
string
Opaque forward cursor returned by a previous call.
string
Return definitions updated after this ISO-8601 time.
integer
SRS definition ID to retrieve directly. When set, list filters and next_cursor must be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_STUDY_MATERIALSRetrieve one study-material record by ID, or list the user’s subject notes and meaning synonyms with subject and update filters.

Input Parameters

array
Study-material record IDs to include.
boolean
Filter by whether the subject is hidden.
string
Opaque forward cursor returned by a previous call.
array
Subject IDs whose study materials should be returned.
array
Subject types to include.
string
Return records updated after this ISO-8601 time.
integer
Study-material record ID to retrieve directly. When set, list filters and next_cursor must be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_STUDY_SUMMARYGet lessons available now and review availability over the next 24 hours for the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_SUBJECTSRetrieve one WaniKani subject by ID, or search radicals, kanji, vocabulary, and kana vocabulary by IDs, types, slugs, levels, visibility, or update time. Results are restricted to levels granted by the connected user’s subscription.

Input Parameters

array
Subject IDs to include.
array
Exact subject slugs to include, such as ground or 日本.
array
Subject resource types to include.
boolean
Filter by whether subjects are hidden.
array
WaniKani levels to include (each 1-60).
integer
Subject ID to retrieve directly. When set, omit search filters and next_cursor.
string
Opaque forward cursor returned by a previous call; pages contain up to 1000 subjects.
string
Return subjects updated after this ISO-8601 time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_USERGet the connected user’s identity, level, subscription status, vacation state, and application preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_GET_VOICE_ACTORSRetrieve one WaniKani pronunciation voice actor by ID, or list voice actors with ID and update-time filters.

Input Parameters

array
Voice actor IDs to include.
string
Opaque forward cursor returned by a previous call.
string
Return voice actors updated after this ISO-8601 time.
integer
Voice actor ID to retrieve directly. When set, omit list filters and next_cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_START_ASSIGNMENTIrreversibly mark one unlocked lesson assignment as started and move it into reviews. Use only after the user explicitly confirms the exact assignment.

Input Parameters

string
Past ISO-8601 start time; omit to use request time. It must not precede the assignment’s unlocked_at time.
integer
required
Unlocked, unstarted assignment ID to start.
boolean
required
Must be true to acknowledge that starting an assignment permanently changes learning progress and cannot be undone through the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_SUBMIT_REVIEWSubmit a completed review, irreversibly changing assignment progress and review statistics; use only with exact answer counts explicitly confirmed by the user. WaniKani returns an unpersisted review with ID 0.

Input Parameters

string
Past ISO-8601 completion time after the assignment’s available_at time; omit to use request time.
integer
Subject whose currently reviewable assignment should be used. Supply exactly one of subject_id or assignment_id.
integer
Assignment to review. Supply exactly one of assignment_id or subject_id.
boolean
required
Must be true to acknowledge that submission permanently changes learning progress and cannot be deleted or corrected through this API.
integer
required
Number of incorrect meaning answers (0 or greater).
integer
required
Number of incorrect reading answers (0 or greater).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_UPDATE_STUDY_MATERIALUpdate at least one note or meaning-synonym field on an existing study-material record without changing its subject.

Input Parameters

string
Replacement personal meaning note. Send an empty string only when intentionally clearing it.
string
Replacement personal reading note. Send an empty string only when intentionally clearing it.
array
Complete replacement synonym list. Send an empty list only when intentionally clearing all synonyms.
integer
required
Existing study-material record ID, not the subject ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WANIKANI_UPDATE_USER_PREFERENCESUpdate one or more supported WaniKani lesson, review, or extra-study preferences. Omitted preferences remain unchanged.

Input Parameters

integer
Number of subjects presented in each lesson batch.
boolean
Whether lessons autoplay audio.
boolean
Whether reviews autoplay audio.
boolean
Whether extra-study sessions autoplay audio.
string ("shuffled" | "lower_levels_first")
Order in which review subjects are presented.
boolean
Whether reviews display the SRS-stage indicator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not