> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# WaniKani

> WaniKani is a spaced-repetition learning platform for studying Japanese radicals, kanji, and vocabulary.

![WaniKani logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/wanikani.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=4c6d626f729f2a7e7bdc69e41cc5bb03)

* **Category:** education
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 16
* **Triggers:** 0
* **Slug:** `WANIKANI`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Study Material
>
> **Slug:** `WANIKANI_CREATE_STUDY_MATERIAL`
>
> Create 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
>
> **subject\_id** `integer` *required*
>
> Subject that does not already have a study-material record.
>
> **meaning\_note** `string`
>
> Optional personal note about the subject's meaning.
>
> **reading\_note** `string`
>
> Optional personal note about the subject's reading.
>
> **meaning\_synonyms** `array`
>
> Optional personal meaning synonyms to accept as correct answers.
>
> **confirm\_undeletable** `boolean` *required*
>
> Must be true to acknowledge that the created record cannot be deleted through the WaniKani API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Assignments
>
> **Slug:** `WANIKANI_GET_ASSIGNMENTS`
>
> Retrieve one assignment by ID, or list the connected user's assignments using progress, availability, level, subject, and update filters.
>
> #### Input Parameters
>
> **ids** `array`
>
> Assignment IDs to include in a list query.
>
> **burned** `boolean`
>
> Filter by whether the assignment is burned.
>
> **hidden** `boolean`
>
> Filter by whether the subject is hidden.
>
> **levels** `array`
>
> WaniKani levels to include (each 1-60).
>
> **started** `boolean`
>
> Filter by whether the lesson assignment has started.
>
> **unlocked** `boolean`
>
> Filter by whether the assignment is unlocked.
>
> **in\_review** `boolean`
>
> Filter by whether the assignment has entered reviews.
>
> **srs\_stages** `array`
>
> SRS stages to include (each 0-9).
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **subject\_ids** `array`
>
> Subject IDs whose assignments should be returned.
>
> **assignment\_id** `integer`
>
> Assignment ID to retrieve directly. When set, omit all list filters and next\_cursor.
>
> **subject\_types** `array`
>
> Subject types to include.
>
> **updated\_after** `string`
>
> Return assignments updated after this ISO-8601 time.
>
> **available\_after** `string`
>
> Return assignments available at or after this ISO-8601 time.
>
> **available\_before** `string`
>
> Return assignments available at or before this ISO-8601 time.
>
> **immediately\_available\_for\_review** `boolean`
>
> Filter to assignments currently available for review.
>
> **immediately\_available\_for\_lessons** `boolean`
>
> Filter to assignments currently available for lessons.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Level Progressions
>
> **Slug:** `WANIKANI_GET_LEVEL_PROGRESSIONS`
>
> Retrieve one level-progression record by ID, or list the user's level history with ID and update-time filters.
>
> #### Input Parameters
>
> **ids** `array`
>
> Level-progression IDs to include.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **updated\_after** `string`
>
> Return records updated after this ISO-8601 time.
>
> **level\_progression\_id** `integer`
>
> Record ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Resets
>
> **Slug:** `WANIKANI_GET_RESETS`
>
> Retrieve one account-reset record by ID, or list account level-reset history.
>
> #### Input Parameters
>
> **ids** `array`
>
> Reset IDs to include.
>
> **reset\_id** `integer`
>
> Reset record ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **updated\_after** `string`
>
> Return reset records updated after this ISO-8601 time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reviews
>
> **Slug:** `WANIKANI_GET_REVIEWS`
>
> Look 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
>
> **ids** `array`
>
> Review IDs to include.
>
> **review\_id** `integer`
>
> Completed review ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **subject\_ids** `array`
>
> Subject IDs whose reviews should be returned.
>
> **updated\_after** `string`
>
> Return reviews updated after this ISO-8601 time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Review Statistics
>
> **Slug:** `WANIKANI_GET_REVIEW_STATISTICS`
>
> Retrieve one per-subject review statistic by ID, or list answer totals, streaks, and accuracy using subject and percentage filters.
>
> #### Input Parameters
>
> **ids** `array`
>
> Statistic record IDs to include.
>
> **hidden** `boolean`
>
> Filter by whether the subject is hidden.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **subject\_ids** `array`
>
> Subject IDs whose statistics should be returned.
>
> **subject\_types** `array`
>
> Subject types to include.
>
> **updated\_after** `string`
>
> Return statistics updated after this ISO-8601 time.
>
> **review\_statistic\_id** `integer`
>
> Statistic record ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> **percentages\_less\_than** `integer`
>
> Return percentages strictly less than this value.
>
> **percentages\_greater\_than** `integer`
>
> Return percentages strictly greater than this value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Spaced Repetition Systems
>
> **Slug:** `WANIKANI_GET_SPACED_REPETITION_SYSTEMS`
>
> Retrieve one spaced-repetition system by ID, or list SRS definitions and their stage intervals.
>
> #### Input Parameters
>
> **ids** `array`
>
> SRS definition IDs to include.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **updated\_after** `string`
>
> Return definitions updated after this ISO-8601 time.
>
> **spaced\_repetition\_system\_id** `integer`
>
> SRS definition ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Study Materials
>
> **Slug:** `WANIKANI_GET_STUDY_MATERIALS`
>
> Retrieve one study-material record by ID, or list the user's subject notes and meaning synonyms with subject and update filters.
>
> #### Input Parameters
>
> **ids** `array`
>
> Study-material record IDs to include.
>
> **hidden** `boolean`
>
> Filter by whether the subject is hidden.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **subject\_ids** `array`
>
> Subject IDs whose study materials should be returned.
>
> **subject\_types** `array`
>
> Subject types to include.
>
> **updated\_after** `string`
>
> Return records updated after this ISO-8601 time.
>
> **study\_material\_id** `integer`
>
> Study-material record ID to retrieve directly. When set, list filters and next\_cursor must be omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Study Summary
>
> **Slug:** `WANIKANI_GET_STUDY_SUMMARY`
>
> Get lessons available now and review availability over the next 24 hours for the connected user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subjects
>
> **Slug:** `WANIKANI_GET_SUBJECTS`
>
> Retrieve 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
>
> **ids** `array`
>
> Subject IDs to include.
>
> **slugs** `array`
>
> Exact subject slugs to include, such as ground or 日本.
>
> **types** `array`
>
> Subject resource types to include.
>
> **hidden** `boolean`
>
> Filter by whether subjects are hidden.
>
> **levels** `array`
>
> WaniKani levels to include (each 1-60).
>
> **subject\_id** `integer`
>
> Subject ID to retrieve directly. When set, omit search filters and next\_cursor.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call; pages contain up to 1000 subjects.
>
> **updated\_after** `string`
>
> Return subjects updated after this ISO-8601 time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `WANIKANI_GET_USER`
>
> Get the connected user's identity, level, subscription status, vacation state, and application preferences.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Voice Actors
>
> **Slug:** `WANIKANI_GET_VOICE_ACTORS`
>
> Retrieve one WaniKani pronunciation voice actor by ID, or list voice actors with ID and update-time filters.
>
> #### Input Parameters
>
> **ids** `array`
>
> Voice actor IDs to include.
>
> **next\_cursor** `string`
>
> Opaque forward cursor returned by a previous call.
>
> **updated\_after** `string`
>
> Return voice actors updated after this ISO-8601 time.
>
> **voice\_actor\_id** `integer`
>
> Voice actor ID to retrieve directly. When set, omit list filters and next\_cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Assignment
>
> **Slug:** `WANIKANI_START_ASSIGNMENT`
>
> Irreversibly mark one unlocked lesson assignment as started and move it into reviews. Use only after the user explicitly confirms the exact assignment.
>
> #### Input Parameters
>
> **started\_at** `string`
>
> Past ISO-8601 start time; omit to use request time. It must not precede the assignment's unlocked\_at time.
>
> **assignment\_id** `integer` *required*
>
> Unlocked, unstarted assignment ID to start.
>
> **confirm\_irreversible** `boolean` *required*
>
> Must be true to acknowledge that starting an assignment permanently changes learning progress and cannot be undone through the API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Review
>
> **Slug:** `WANIKANI_SUBMIT_REVIEW`
>
> Submit 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
>
> **created\_at** `string`
>
> Past ISO-8601 completion time after the assignment's available\_at time; omit to use request time.
>
> **subject\_id** `integer`
>
> Subject whose currently reviewable assignment should be used. Supply exactly one of subject\_id or assignment\_id.
>
> **assignment\_id** `integer`
>
> Assignment to review. Supply exactly one of assignment\_id or subject\_id.
>
> **confirm\_irreversible** `boolean` *required*
>
> Must be true to acknowledge that submission permanently changes learning progress and cannot be deleted or corrected through this API.
>
> **incorrect\_meaning\_answers** `integer` *required*
>
> Number of incorrect meaning answers (0 or greater).
>
> **incorrect\_reading\_answers** `integer` *required*
>
> Number of incorrect reading answers (0 or greater).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Study Material
>
> **Slug:** `WANIKANI_UPDATE_STUDY_MATERIAL`
>
> Update at least one note or meaning-synonym field on an existing study-material record without changing its subject.
>
> #### Input Parameters
>
> **meaning\_note** `string`
>
> Replacement personal meaning note. Send an empty string only when intentionally clearing it.
>
> **reading\_note** `string`
>
> Replacement personal reading note. Send an empty string only when intentionally clearing it.
>
> **meaning\_synonyms** `array`
>
> Complete replacement synonym list. Send an empty list only when intentionally clearing all synonyms.
>
> **study\_material\_id** `integer` *required*
>
> Existing study-material record ID, not the subject ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Preferences
>
> **Slug:** `WANIKANI_UPDATE_USER_PREFERENCES`
>
> Update one or more supported WaniKani lesson, review, or extra-study preferences. Omitted preferences remain unchanged.
>
> #### Input Parameters
>
> **lessons\_batch\_size** `integer`
>
> Number of subjects presented in each lesson batch.
>
> **lessons\_autoplay\_audio** `boolean`
>
> Whether lessons autoplay audio.
>
> **reviews\_autoplay\_audio** `boolean`
>
> Whether reviews autoplay audio.
>
> **extra\_study\_autoplay\_audio** `boolean`
>
> Whether extra-study sessions autoplay audio.
>
> **reviews\_presentation\_order** `string ("shuffled" | "lower_levels_first")`
>
> Order in which review subjects are presented.
>
> **reviews\_display\_srs\_indicator** `boolean`
>
> Whether reviews display the SRS-stage indicator.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
