---
canonical_url: "https://docs.composio.dev/toolkits/wanikani"
markdown_url: "https://docs.composio.dev/toolkits/wanikani.md"
product: "platform"
version: null
last_updated: null
---

# WaniKani

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

- **Category:** education
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `WANIKANI`
- **Version:** 00000000_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subject_id` | integer | Yes | Subject that does not already have a study-material record. |
| `meaning_note` | string | No | Optional personal note about the subject's meaning. |
| `reading_note` | string | No | Optional personal note about the subject's reading. |
| `meaning_synonyms` | array | No | Optional personal meaning synonyms to accept as correct answers. |
| `confirm_undeletable` | boolean | Yes | Must be true to acknowledge that the created record cannot be deleted through the WaniKani API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Resets

**Slug:** `WANIKANI_GET_RESETS`

Retrieve one account-reset record by ID, or list account level-reset history.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reviews

**Slug:** `WANIKANI_GET_REVIEWS`

Retrieve one completed review by ID, or list completed reviews filtered by review IDs, subject IDs, or update time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Review IDs to include. |
| `review_id` | integer | No | Completed review ID to retrieve directly. When set, list filters and next_cursor must be omitted. |
| `next_cursor` | string | No | Opaque forward cursor returned by a previous call. |
| `subject_ids` | array | No | Subject IDs whose reviews should be returned. |
| `updated_after` | string | No | Return reviews updated after this ISO-8601 time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | SRS definition IDs to include. |
| `next_cursor` | string | No | Opaque forward cursor returned by a previous call. |
| `updated_after` | string | No | Return definitions updated after this ISO-8601 time. |
| `spaced_repetition_system_id` | integer | No | SRS definition ID to retrieve directly. When set, list filters and next_cursor must be omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `WANIKANI_GET_USER`

Get the connected user's identity, level, subscription status, vacation state, and application preferences.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Voice actor IDs to include. |
| `next_cursor` | string | No | Opaque forward cursor returned by a previous call. |
| `updated_after` | string | No | Return voice actors updated after this ISO-8601 time. |
| `voice_actor_id` | integer | No | Voice actor ID to retrieve directly. When set, omit list filters and next_cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `started_at` | string | No | Past ISO-8601 start time; omit to use request time. It must not precede the assignment's unlocked_at time. |
| `assignment_id` | integer | Yes | Unlocked, unstarted assignment ID to start. |
| `confirm_irreversible` | boolean | Yes | Must be true to acknowledge that starting an assignment permanently changes learning progress and cannot be undone through the API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Review

**Slug:** `WANIKANI_SUBMIT_REVIEW`

Irreversibly submit a completed review, changing assignment progress and review statistics. Use only with exact answer counts explicitly confirmed by the user.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meaning_note` | string | No | Replacement personal meaning note. Send an empty string only when intentionally clearing it. |
| `reading_note` | string | No | Replacement personal reading note. Send an empty string only when intentionally clearing it. |
| `meaning_synonyms` | array | No | Complete replacement synonym list. Send an empty list only when intentionally clearing all synonyms. |
| `study_material_id` | integer | Yes | Existing study-material record ID, not the subject ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Preferences

**Slug:** `WANIKANI_UPDATE_USER_PREFERENCES`

Update one or more supported WaniKani lesson or review preferences. Omitted preferences remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lessons_batch_size` | integer | No | Number of subjects presented in each lesson batch. |
| `lessons_autoplay_audio` | boolean | No | Whether lessons autoplay audio. |
| `reviews_autoplay_audio` | boolean | No | Whether reviews autoplay audio. |
| `extra_study_autoplay_audio` | boolean | No | Whether extra-study sessions autoplay audio. |
| `reviews_presentation_order` | string ("shuffled" | "lower_levels_first") | No | Order in which review subjects are presented. |
| `reviews_display_srs_indicator` | boolean | No | Whether reviews display the SRS-stage indicator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |