Sends an SMS verification code to a phone number for password reset purposes. Checks if the user exists.

Send reset SMS

Error sending SMS or database connection failed.

Send SMS verification for password reset

Cati Docs

Welcome to the technical documentation of Cati, the virtual assistant designed for the elderly

Introduction

Brand book

Product roadmap

Frontend

Emotions

Audio messages

Image sharing

User authentication

Registers a new assistant user, of type `OWNER`, and generates a security code for the companion mobile app connection. Returns an access token for the assistant.

Register assistant

Registers a new `APP` type user with a phone number, password, and full name after validating an SMS code. Returns an access token for the registered app user.

Register app user

Sends an SMS verification code to a phone number. Used during app user registration to check if the number is already registered.

Send SMS code

Authenticates a mobile app user using phone number and password, then returns an access token.

Login app user

Validates a security code provided by an assistant device and establishes a connection between a mobile app user and an assistant. The mobile app user's token is passed in the body.

Connect with app

Retrieves the user ID from the provided JWT access token. The user's token is passed in the body.

Get user id

Updates the full name and/or image of the authenticated mobile app user. The user's token is passed in the body.

Update user basic data

Updates the phone number of the authenticated mobile app user after validating an SMS code to the new phone number. The user's token is passed in the body.

Update phone number

Validates an SMS code and generates a JWT token for password reset.

Check reset SMS

Verifies a password reset token and updates the user's password.

Perform password reset

Retrieves a list of phone numbers and basic info of mobile app users connected to the authenticated assistant device. The assistant's token is passed in the body.

Connected users

Retrieves a list of all assistants connected to the authenticated mobile app user. The user's token is passed in the body.

Connected assistants

Generates a new, time-limited security code for an assistant, allowing mobile app users to connect to it. The assistant's token is passed in the body.

Get assistant code

Allows a mobile app user to send an image to a specific assistant. The sender's token is passed in the body.

Send an image

Allows a mobile app user to send an audio message to a specific assistant. A push notification is sent to the assistant. The sender's token is passed in the body.

Send an audio

Retrieves images sent to an assistant since a given timestamp. Optionally filters by sender. The receiver's token is passed in the body.

Receive images

Retrieves audio messages sent to an assistant since a given timestamp. Optionally filters by sender. The receiver's token is passed in the body.

Receive audios

Retrieves a paginated list of images and audio messages sent to or from the authenticated mobile app user, sorted by recency. The user's token is passed in the body.

Receive media (mobile)

Retrieves all contacts associated with the authenticated assistant device, including connected mobile app users. The assistant's token is passed in the body.

Get contacts (dock)

Retrieves contacts associated with a specific assistant, accessible by a connected mobile app user. The mobile app user's token and the assistant's ID are passed in the body.

Get contacts (mobile)

Allows a mobile app user to create a new contact for a specific assistant, or globally for all connected assistants. The mobile app user's token is passed in the body.

Create contact (mobile)

Allows a mobile app user to edit an existing contact for a specific assistant. Requires the mobile user to be connected to the assistant and the contact to belong to that assistant. The mobile app user's token is passed in the body.

Edit contact (mobile)

Allows a mobile app user to delete an existing contact for a specific assistant. Requires the mobile user to be connected to the assistant and the contact to belong to that assistant. The mobile app user's token is passed in the body.

Delete contact (mobile)

Retrieves a list of all users with `OWNER` user_type, excluding the requesting user. The assistant's `token` is passed in the body.

Get owner users

Retrieves a list of the most recently active users based on assistant interactions.

Latest active users

Allows a user to join an existing video call room with less than 4 participants, or creates a new room if none are available. Also returns a list of potential invite candidates if a new room is created.

Join a room

Updates the last active timestamp for a user in a specific video call room, indicating their presence.

Send a heartbeat

Sends a push notification to specified user IDs to alert them of an incoming video call. Generates a video calling code.

Send a videocall push

Song search

Song URL

Artist songs

Retrieves all calendar events for an assistant, identified by a JWT token.

Get events

Adds a single new event to the assistant's calendar. The assistant is identified by the provided JWT token.

Add event

Deletes all existing events for an assistant and replaces them with a new list of events. The assistant is identified by the provided JWT token.

Delete event

Retrieves all calendar events for a specific assistant, verifying that the mobile user (identified by token) is connected to that assistant.

Get events (mobile)

Adds a single new event to an assistant's calendar, initiated by a connected mobile user.

Add event (mobile)

Deletes all existing events for an assistant and replaces them with a new list, initiated by a connected mobile user.

API Documentation

Authentication & Users

Connection

Media

Contacts

Users

Rooms

Music

Calendar

Send reset SMS

Body

Response