# Cati Docs

## Docs

- [User authentication](https://docs.holacati.com/api-reference/authentication.md): How the register process works
- [Add event](https://docs.holacati.com/api-reference/endpoint/calendar/add-event.md): Adds a single new event to the assistant's calendar. The assistant is identified by the provided JWT token.
- [Add event (mobile)](https://docs.holacati.com/api-reference/endpoint/calendar/add-event-mobile.md): Adds a single new event to an assistant's calendar, initiated by a connected mobile user.
- [Delete event](https://docs.holacati.com/api-reference/endpoint/calendar/delete-event.md): 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.
- [Get events](https://docs.holacati.com/api-reference/endpoint/calendar/get-events.md): Retrieves all calendar events for an assistant, identified by a JWT token.
- [Get events (mobile)](https://docs.holacati.com/api-reference/endpoint/calendar/get-events-mobile.md): Retrieves all calendar events for a specific assistant, verifying that the mobile user (identified by token) is connected to that assistant.
- [Update events (mobile)](https://docs.holacati.com/api-reference/endpoint/calendar/update-events-mobile.md): Deletes all existing events for an assistant and replaces them with a new list, initiated by a connected mobile user.
- [Get assistant code](https://docs.holacati.com/api-reference/endpoint/connections/get-code.md): 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.
- [Connected assistants](https://docs.holacati.com/api-reference/endpoint/connections/get-connected-assistants.md): Retrieves a list of all assistants connected to the authenticated mobile app user. The user's token is passed in the body.
- [Connected users](https://docs.holacati.com/api-reference/endpoint/connections/get-connected-users.md): 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.
- [Create contact (mobile)](https://docs.holacati.com/api-reference/endpoint/contacts/create-contact.md): 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.
- [Delete contact (mobile)](https://docs.holacati.com/api-reference/endpoint/contacts/delete-contact.md): 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.
- [Edit contact (mobile)](https://docs.holacati.com/api-reference/endpoint/contacts/edit-contact.md): 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.
- [Get contacts (dock)](https://docs.holacati.com/api-reference/endpoint/contacts/get-contacts.md): 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 (mobile)](https://docs.holacati.com/api-reference/endpoint/contacts/get-contacts-mobile.md): 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.
- [Receive audios](https://docs.holacati.com/api-reference/endpoint/media/receive-audio.md): 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 images](https://docs.holacati.com/api-reference/endpoint/media/receive-image.md): Retrieves images sent to an assistant since a given timestamp. Optionally filters by sender. The receiver's token is passed in the body.
- [Receive media (mobile)](https://docs.holacati.com/api-reference/endpoint/media/receive-media-mobile.md): 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.
- [Send an audio](https://docs.holacati.com/api-reference/endpoint/media/send-audio.md): 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 image](https://docs.holacati.com/api-reference/endpoint/media/send-image.md): Allows a mobile app user to send an image to a specific assistant. The sender's token is passed in the body.
- [Artist songs](https://docs.holacati.com/api-reference/endpoint/music/artistsongs.md): Get an artist's top songs
- [Song search](https://docs.holacati.com/api-reference/endpoint/music/songsearch.md): Search for a song
- [Song URL](https://docs.holacati.com/api-reference/endpoint/music/songurl.md): Get the playback URL for a song
- [Send a heartbeat](https://docs.holacati.com/api-reference/endpoint/rooms/room_heartbeat.md): Updates the last active timestamp for a user in a specific video call room, indicating their presence.
- [Join a room](https://docs.holacati.com/api-reference/endpoint/rooms/room_join.md): 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.
- [Send a videocall push](https://docs.holacati.com/api-reference/endpoint/rooms/send-videocall-push.md): Sends a push notification to specified user IDs to alert them of an incoming video call. Generates a video calling code.
- [Connect with app](https://docs.holacati.com/api-reference/endpoint/users/connect.md): 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.
- [Check reset SMS](https://docs.holacati.com/api-reference/endpoint/users/generate-password-reset-token.md): Validates an SMS code and generates a JWT token for password reset.
- [Get owner users](https://docs.holacati.com/api-reference/endpoint/users/get-owners.md): Retrieves a list of all users with `OWNER` user_type, excluding the requesting user. The assistant's `token` is passed in the body.
- [Get user id](https://docs.holacati.com/api-reference/endpoint/users/get-user-id.md): Retrieves the user ID from the provided JWT access token. The user's token is passed in the body.
- [Latest active users](https://docs.holacati.com/api-reference/endpoint/users/latest_active_users.md): Retrieves a list of the most recently active users based on assistant interactions.
- [Login app user](https://docs.holacati.com/api-reference/endpoint/users/login-appuser.md): Authenticates a mobile app user using phone number and password, then returns an access token.
- [Register app user](https://docs.holacati.com/api-reference/endpoint/users/register-appuser.md): 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 assistant](https://docs.holacati.com/api-reference/endpoint/users/register-assistant.md): 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.
- [Perform password reset](https://docs.holacati.com/api-reference/endpoint/users/reset-password.md): Verifies a password reset token and updates the user's password.
- [Send reset SMS](https://docs.holacati.com/api-reference/endpoint/users/send-reset-sms.md): Sends an SMS verification code to a phone number for password reset purposes. Checks if the user exists.
- [Send SMS code](https://docs.holacati.com/api-reference/endpoint/users/send-sms.md): Sends an SMS verification code to a phone number. Used during app user registration to check if the number is already registered.
- [Update user basic data](https://docs.holacati.com/api-reference/endpoint/users/update-user-basic-data.md): Updates the full name and/or image of the authenticated mobile app user. The user's token is passed in the body.
- [Update phone number](https://docs.holacati.com/api-reference/endpoint/users/update-user-phone-number.md): 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.
- [Introduction](https://docs.holacati.com/api-reference/introduction.md): API endpoints introduction
- [Brand book](https://docs.holacati.com/brand.md): Discover our brand design
- [Emotions](https://docs.holacati.com/emotions.md): Learn how our assistant conveys emotions
- [Audio messages](https://docs.holacati.com/essentials/audiomessages.md): Send and receive audio messages
- [Image sharing](https://docs.holacati.com/essentials/imagesharing.md): Receive images from your contacts
- [Frontend](https://docs.holacati.com/frontend.md): Understand the basics of our frontend
- [Introduction](https://docs.holacati.com/index.md): Welcome to the technical documentation of Cati, the virtual assistant designed for the elderly
- [Product roadmap](https://docs.holacati.com/roadmap.md): Send and receive audio messages

## OpenAPI Specs

- [openapi-calendar](https://docs.holacati.com/api-reference/openapi-calendar.json)
- [openapi](https://docs.holacati.com/api-reference/openapi.json)
- [openapi-music](https://docs.holacati.com/api-reference/openapi-music.json)

## Optional

- [Documentation](https://cati.mintlify.app/)
- [Support](https://mintlify.com/community)
- [Status](https://cati.statuspage.io)