.. _api-users:

Users API
=========

Endpoints related to user profiles and streaks.
All endpoints are prefixed with ``/api/users``.

Endpoints
---------

GET /api/users/profile
~~~~~~~~~~~~~~~~~~~~~~

Get the current user's profile information, including level, streak, and fluency points.

**Response** ``200 OK``

.. code-block:: json

   {
     "full_name": "Jane Doe",
     "email": "jane@example.com",
     "level": "Upper Intermediate",
     "fluency_points": 350,
     "current_streak": 5
   }

PUT /api/users/profile
~~~~~~~~~~~~~~~~~~~~~~

Update the current user's profile details.

**Request Body:**

.. code-block:: json

   {
     "full_name": "Jane Smith"
   }

**Response** ``200 OK``

Returns the updated profile object.

POST /api/users/streak/ping
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ping the streak service to increment or maintain the user's current daily streak.

**Response** ``200 OK``

.. code-block:: json

   {
     "current_streak": 6
   }