Review Start

Start a new review session. Returns session ID and cards.

POST /api/chinese/review/start

Review Start

cURL

curl --request POST \
  --url https://api.example.com/api/chinese/review/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "hsk_level": 123,
  "lesson_id": "<string>",
  "limit": 20,
  "session_type": "mixed"
}
'

200

{
  "session_id": "<string>",
  "cards": [
    {
      "attempt_type": "pinyin",
      "progress": {
        "word_id": "<string>",
        "character_attempts": 0,
        "character_correct": 0,
        "ease_factor": 2.5,
        "interval_days": 0,
        "last_reviewed_at": "<string>",
        "listening_attempts": 0,
        "listening_correct": 0,
        "meaning_attempts": 0,
        "meaning_correct": 0,
        "next_review_at": "<string>",
        "pinyin_attempts": 0,
        "pinyin_correct": 0,
        "repetitions": 0,
        "status": "new"
      },
      "word": {
        "frequency_rank": 2,
        "hsk_level": 3,
        "id": "<string>",
        "lesson_group": "<string>",
        "meaning_en": "<string>",
        "part_of_speech": "<string>",
        "pinyin": "<string>",
        "pinyin_numbered": "<string>",
        "radical": "<string>",
        "simplified": "<string>",
        "stroke_count": 2,
        "traditional": "<string>",
        "examples": [
          {
            "chinese": "<string>",
            "context": "everyday",
            "english": "<string>",
            "pinyin": "<string>"
          }
        ],
        "tags": [
          "<string>"
        ]
      }
    }
  ],
  "total_cards": 0
}

Body

application/json

Request to start a new review session.

hsk_level · integer | null

lesson_id · string | null

limit · integer · default: 20

Required range: 1 <= x <= 50

session_type · enum<string> · default: mixed

Available options: pinyin, meaning, character, listening, mixed

Response

200

application/json

Successful Response

Response with session ID and cards.

session_id · string · required

cards · ReviewCard · object[]

Show child attributes

total_cards · integer · default: 0

Required range: x >= 0