# Chatenium API ## API Docs - WebSocket [WebSocket upgrade](https://apispecs.chatenium.hu/websocket-upgrade-39081964e0.md): - Auth [Rotate token pair](https://apispecs.chatenium.hu/rotate-token-pair-39081965e0.md): Called when the access token expires. Generates a new pair of tokens and returns them to the user. - Auth [SignIn methods](https://apispecs.chatenium.hu/signin-methods-39081966e0.md): Fetch available authentication methods for the specified account. - Auth [Apple OAuth](https://apispecs.chatenium.hu/apple-oauth-39081967e0.md): Authenticate using Apple. - Auth [Google OAuth](https://apispecs.chatenium.hu/google-oauth-39081968e0.md): Authenticate using Google. - Auth [Username Availability](https://apispecs.chatenium.hu/username-availability-39081969e0.md): Fetches whether the specified username is available or not. - Auth [Email Availability](https://apispecs.chatenium.hu/email-availability-39081970e0.md): Fetches whether the specified e-mail address is available or not. - Auth [Sign In](https://apispecs.chatenium.hu/sign-in-39081971e0.md): Signs in the user and returns an access/refresh token pair + the user's ID. - Auth [Passwordless Registration](https://apispecs.chatenium.hu/passwordless-registration-39081972e0.md): Passwordless Registration: Registers a new user without a password. The user will need to provide a temporary code on every authentication. - Auth [Register](https://apispecs.chatenium.hu/register-39081973e0.md): Validates the provided user data, registers them in the database and signs the user in. - Auth [Password Reset](https://apispecs.chatenium.hu/password-reset-39081974e0.md): Verifies the provided token and updates the user's password. The user does not get signed in automatically. - Auth [Refresh Token Pair](https://apispecs.chatenium.hu/refresh-token-pair-39081975e0.md): Removes the current refresh token, puts the current access token to a blacklist, generates a new pair of tokens and returns them to the user. - Auth [Register Challenge](https://apispecs.chatenium.hu/register-challenge-39081976e0.md): Registers a new challenge challenge attempt. - Auth [Credential Verification](https://apispecs.chatenium.hu/credential-verification-39081977e0.md): With the submitted credential, an attempt will be made to verify one factor. - Auth [Request credential](https://apispecs.chatenium.hu/request-credential-39081978e0.md): Requests a credential for specific factors (SMS, E-Mail). - Auth [Fetch User ID](https://apispecs.chatenium.hu/fetch-user-id-39081979e0.md): Fetches the user's ID from the provided identity. - Account [Register FCM Token](https://apispecs.chatenium.hu/register-fcm-token-39081980e0.md): - Account [Register APNS Token](https://apispecs.chatenium.hu/register-apns-token-39081981e0.md): - Account [Change Username](https://apispecs.chatenium.hu/change-username-39081982e0.md): - Account [Change Display Name](https://apispecs.chatenium.hu/change-display-name-39081983e0.md): - Account [Delete Account](https://apispecs.chatenium.hu/delete-account-39081984e0.md): - Account [Change Email](https://apispecs.chatenium.hu/change-email-39081985e0.md): - Account [Get Sessions](https://apispecs.chatenium.hu/get-sessions-39081986e0.md): - Account [Logout Session](https://apispecs.chatenium.hu/logout-session-39081987e0.md): - Account [Toggle GIF Save](https://apispecs.chatenium.hu/toggle-gif-save-39081988e0.md): - Account [Change Phone Number](https://apispecs.chatenium.hu/change-phone-number-39081989e0.md): - Account [Register PFP Upload](https://apispecs.chatenium.hu/register-pfp-upload-39081990e0.md): - Account [Upload PFP](https://apispecs.chatenium.hu/upload-pfp-39081991e0.md): This is not the actual URL you should use. Use this for a reference point only. The actual URL is returned in the response. - Account [Complete PFP Upload](https://apispecs.chatenium.hu/complete-pfp-upload-39081992e0.md): - Call [Get access](https://apispecs.chatenium.hu/get-access-39081993e0.md): Gathers TURN and STUN servers and a LiveKit token for a successful WebRTC connection - Call [Invite partner](https://apispecs.chatenium.hu/invite-partner-39081994e0.md): **You cannot invite network members, only chat partners!** Invites your chat partner to join the call. The user will be notified about the call by various PUSH notification systems. - Contacts [Get contacts](https://apispecs.chatenium.hu/get-contacts-39081995e0.md): Fetches each contact that is associated with the user ordered by the last time a message was sent. - Contacts [Create new contact](https://apispecs.chatenium.hu/create-new-contact-39081996e0.md): Sends a request to the specified partner who can either accept the request by sending you a message or ignore it. - Contacts [Mute contact](https://apispecs.chatenium.hu/mute-contact-39081997e0.md): When muted, you will not receive notifications from the contact. - Contacts [Delete contact](https://apispecs.chatenium.hu/delete-contact-39081998e0.md): Deletes the contact from your contacts list and removes all DMs with the contact. - Direct messaging [Delete message(s)](https://apispecs.chatenium.hu/delete-messages-39081999e0.md): Deletes the specified message(s) - Direct messaging [Get](https://apispecs.chatenium.hu/get-39082000e0.md): Fetches all messages inside the chat - Direct messaging [Send message](https://apispecs.chatenium.hu/send-message-39082001e0.md): Sends a new message into the chat - Direct messaging [Pinned messages](https://apispecs.chatenium.hu/pinned-messages-39082002e0.md): Gets all pinned messages inside the chat - Direct messaging [Pin message](https://apispecs.chatenium.hu/pin-message-39082003e0.md): Pins the specified message - Direct messaging [Unpin message](https://apispecs.chatenium.hu/unpin-message-39082004e0.md): Unpins the specified message - Direct messaging [Edit message](https://apispecs.chatenium.hu/edit-message-39082005e0.md): Edits the content of the specified message - Direct messaging [Get position](https://apispecs.chatenium.hu/get-position-39082006e0.md): Gets the position of a message which can be passed as query param in get to load that section of messages - Direct messaging [Register attachment(s) upload](https://apispecs.chatenium.hu/register-attachments-upload-39082007e0.md): Registers the upload(s) and returns necessary data to complete the actual upload - Direct messaging [Complete attachment upload](https://apispecs.chatenium.hu/complete-attachment-upload-39082008e0.md): Marks the upload as completed. After that the fileId can be provided when sending a message. - Direct messaging [Register attachment(s) upload](https://apispecs.chatenium.hu/register-attachments-upload-39082009e0.md): Registers the upload(s) and returns necessary data to complete the actual upload - Direct messaging [Complete attachment upload](https://apispecs.chatenium.hu/complete-attachment-upload-39082010e0.md): Marks the upload as completed. After that the fileId can be provided when sending a message. - File transfer [Start new](https://apispecs.chatenium.hu/start-new-39082011e0.md): Starts a new file transfer with the specified user. The 2 users must have each other in their contacts - File transfer [Accept](https://apispecs.chatenium.hu/accept-39082012e0.md): Accepts the file transfer and allows to establish a WebRTC connection - File transfer [Decline](https://apispecs.chatenium.hu/decline-39082013e0.md): Declines the file transfer - File transfer [WebRTC Offer SDP](https://apispecs.chatenium.hu/webrtc-offer-sdp-39082014e0.md): Sends the WebRTC Offer SDP **(Sender Only)** - File transfer [WebRTC Answer SDP](https://apispecs.chatenium.hu/webrtc-answer-sdp-39082015e0.md): Sends the WebRTC Answer SDP **(Receiver Only)** - File transfer [WebRTC ICE Candidate](https://apispecs.chatenium.hu/webrtc-ice-candidate-39082016e0.md): Sends the WebRTC ICE Candidate **(Receiver and Sender)** - Cascade [Register new picture upload](https://apispecs.chatenium.hu/register-new-picture-upload-39082017e0.md): Returns credentials to upload a new cascade picture. - Cascade [Complete Cascade Picture Upload](https://apispecs.chatenium.hu/complete-cascade-picture-upload-39082018e0.md): - Cascade [Create new](https://apispecs.chatenium.hu/create-new-39082019e0.md): Creates a new cascade with the provided data - Cascade [Get](https://apispecs.chatenium.hu/get-39082020e0.md): Gets all cascades that the user owns or a member of - Cascade [Leave/Delete](https://apispecs.chatenium.hu/leavedelete-39082021e0.md): Deletes or leaves the cascade based on whether the users owns the cascade or not - Cascade [Kick/Ban member](https://apispecs.chatenium.hu/kickban-member-39082022e0.md): Kicks or bans a member based on what the client chose - Cascade [Get bans](https://apispecs.chatenium.hu/get-bans-39082023e0.md): Fetches all banned members - Cascade [Unban member](https://apispecs.chatenium.hu/unban-member-39082024e0.md): Unbans the specified member - Cascade [Discovery](https://apispecs.chatenium.hu/discovery-39082025e0.md): Fetches all public cascades with small insights - Cascade [Get from invite](https://apispecs.chatenium.hu/get-from-invite-39082026e0.md): Fetches the cascade's data that the invite is valid for - Cascade [Join from invite](https://apispecs.chatenium.hu/join-from-invite-39082027e0.md): Joins the cascade with a valid invite - Cascade [Join public](https://apispecs.chatenium.hu/join-public-39082028e0.md): Joins the public cascade - Cascade [Edit name](https://apispecs.chatenium.hu/edit-name-39082029e0.md): Sets a new name for the cascade - Cascade [Change visibility](https://apispecs.chatenium.hu/change-visibility-39082030e0.md): Changes the visibility of the cascade - Cascade [Get threads](https://apispecs.chatenium.hu/get-threads-39082031e0.md): Fetches all threads from a specific parent (For root threads use null as parentId) - Thread [Start a new thread](https://apispecs.chatenium.hu/start-a-new-thread-39082032e0.md): Starts a new thread inside the cascade - Thread [Close thread](https://apispecs.chatenium.hu/close-thread-39082033e0.md): Deletes the specified thread and all subthreads - Thread [Update thread](https://apispecs.chatenium.hu/update-thread-39082034e0.md): Updates the thread - Thread Messages [Delete message(s)](https://apispecs.chatenium.hu/delete-messages-39082035e0.md): Deletes the specified message(s) - Thread Messages [Get](https://apispecs.chatenium.hu/get-39082036e0.md): Fetches all messages inside the chat - Thread Messages [Send message](https://apispecs.chatenium.hu/send-message-39082037e0.md): Sends a new message into the thread - Thread Messages [Pinned messages](https://apispecs.chatenium.hu/pinned-messages-39082038e0.md): Gets all pinned messages inside the thread - Thread Messages [Pin message](https://apispecs.chatenium.hu/pin-message-39082039e0.md): Pins the specified message - Thread Messages [Unpin message](https://apispecs.chatenium.hu/unpin-message-39082040e0.md): Unpins the specified message - Thread Messages [Edit message](https://apispecs.chatenium.hu/edit-message-39082041e0.md): Edits the content of the specified message - Thread Messages [Get position](https://apispecs.chatenium.hu/get-position-39082042e0.md): Gets the position of a message which can be passed as query param in get to load that section of messages - Pictures creator [Follow](https://apispecs.chatenium.hu/follow-39082043e0.md): (un)follows the creator - Pictures creator [Details](https://apispecs.chatenium.hu/details-39082044e0.md): Fetches user data and albums/pictures count - Pictures creator [Discovery participation](https://apispecs.chatenium.hu/discovery-participation-39082045e0.md): Toggles whether the user's uploads should be included in discovery - Pictures [Get pictures](https://apispecs.chatenium.hu/get-pictures-39082046e0.md): Fetches pictures uploaded to a specific album. If albumId is not provided then pictures uploaded without an album will be fetched. - Pictures [Upload pictures](https://apispecs.chatenium.hu/upload-pictures-39082047e0.md): Registers are uploaded pictures in the database. - Pictures [Register picture uploads](https://apispecs.chatenium.hu/register-picture-uploads-39082048e0.md): Returns credentials to upload a set amount of pictures. - Pictures [Delete picture](https://apispecs.chatenium.hu/delete-picture-39082049e0.md): Deletes the specified picture. - Pictures [Edit picture](https://apispecs.chatenium.hu/edit-picture-39082050e0.md): Modifies the specified picture. - Pictures [Like picture](https://apispecs.chatenium.hu/like-picture-39082051e0.md): (dis)Likes the specified picture. - Pictures [Discovery](https://apispecs.chatenium.hu/discovery-39082052e0.md): Fetches all recent and most liked public pictures. - Picture comments [Post comment](https://apispecs.chatenium.hu/post-comment-39082053e0.md): Posts a new comment under the specified picture. - Picture comments [Get comments](https://apispecs.chatenium.hu/get-comments-39082054e0.md): Fetches all comments under the specified picture. - Picture comments [Edit comment](https://apispecs.chatenium.hu/edit-comment-39082055e0.md): Updates the content of the specified comment. - Picture comments [Delete comment](https://apispecs.chatenium.hu/delete-comment-39082056e0.md): Deletes the specified comment. - Picture album [Create new](https://apispecs.chatenium.hu/create-new-39082057e0.md): Creates a new album - Picture album [Get](https://apispecs.chatenium.hu/get-39082058e0.md): Gets all albums - Picture album [Delete](https://apispecs.chatenium.hu/delete-39082059e0.md): Deletes the specified album - Picture album [Edit](https://apispecs.chatenium.hu/edit-39082060e0.md): Modifies the specified album's data ## Schemas - [SuccessfulAuthResp](https://apispecs.chatenium.hu/successfulauthresp-16136138d0.md): - [AuthMethods](https://apispecs.chatenium.hu/authmethods-16136139d0.md): - [AppleOAuthReq](https://apispecs.chatenium.hu/appleoauthreq-16136140d0.md): - [GoogleOAuthReq](https://apispecs.chatenium.hu/googleoauthreq-16136141d0.md): - [DataAvailabilityResp](https://apispecs.chatenium.hu/dataavailabilityresp-16136142d0.md): - [SignInReq](https://apispecs.chatenium.hu/signinreq-16136143d0.md): - [PasswordlessRegisterReq](https://apispecs.chatenium.hu/passwordlessregisterreq-16136144d0.md): - [RegisterReq](https://apispecs.chatenium.hu/registerreq-16136145d0.md): - [PasswordResetReq](https://apispecs.chatenium.hu/passwordresetreq-16136146d0.md): - [GenericSuccessBody](https://apispecs.chatenium.hu/genericsuccessbody-16136147d0.md): - [RefreshTokenPairReq](https://apispecs.chatenium.hu/refreshtokenpairreq-16136148d0.md): - [ChallengeDataOverride](https://apispecs.chatenium.hu/challengedataoverride-16136149d0.md): - [RegisterAuthAttemptReq](https://apispecs.chatenium.hu/registerauthattemptreq-16136150d0.md): - [Factor](https://apispecs.chatenium.hu/factor-16136151d0.md): - [Challenge](https://apispecs.chatenium.hu/challenge-16136152d0.md): - [VerifyFactorReq](https://apispecs.chatenium.hu/verifyfactorreq-16136153d0.md): - [RequestFactorCredentialReq](https://apispecs.chatenium.hu/requestfactorcredentialreq-16136154d0.md): - [GetIdFromIdentityResp](https://apispecs.chatenium.hu/getidfromidentityresp-16136155d0.md): - [RegisterFcmTokenReq](https://apispecs.chatenium.hu/registerfcmtokenreq-16136156d0.md): - [RegisterApnsTokenReq](https://apispecs.chatenium.hu/registerapnstokenreq-16136157d0.md): - [ChangeUsernameReq](https://apispecs.chatenium.hu/changeusernamereq-16136158d0.md): - [ChangeDisplayNameReq](https://apispecs.chatenium.hu/changedisplaynamereq-16136159d0.md): - [DeleteAccountReq](https://apispecs.chatenium.hu/deleteaccountreq-16136160d0.md): - [SessionV3](https://apispecs.chatenium.hu/sessionv3-16136161d0.md): - [ToggleGifReq](https://apispecs.chatenium.hu/togglegifreq-16136162d0.md): - [S3PresignedFileReq](https://apispecs.chatenium.hu/s3presignedfilereq-16136163d0.md): - [S3PresignedFileResponse](https://apispecs.chatenium.hu/s3presignedfileresponse-16136164d0.md): - [S3MultipartUploadReq](https://apispecs.chatenium.hu/s3multipartuploadreq-16136165d0.md): - [CompletePfpUploadReq](https://apispecs.chatenium.hu/completepfpuploadreq-16136166d0.md): - [GetAccessResp](https://apispecs.chatenium.hu/getaccessresp-16136167d0.md): - [LatestMessage](https://apispecs.chatenium.hu/latestmessage-16136168d0.md): - [Contact](https://apispecs.chatenium.hu/contact-16136169d0.md): - [AddContactReq](https://apispecs.chatenium.hu/addcontactreq-16136170d0.md): - [SetMuteReq](https://apispecs.chatenium.hu/setmutereq-16136171d0.md): - [PublicUserData](https://apispecs.chatenium.hu/publicuserdata-16136172d0.md): - [Attachment](https://apispecs.chatenium.hu/attachment-16136173d0.md): - [Message](https://apispecs.chatenium.hu/message-16136174d0.md): - [SendMessageReq](https://apispecs.chatenium.hu/sendmessagereq-16136175d0.md): - [PinnedMessage](https://apispecs.chatenium.hu/pinnedmessage-16136176d0.md): - [GetPositionResp](https://apispecs.chatenium.hu/getpositionresp-16136177d0.md): - [EditMessageReq](https://apispecs.chatenium.hu/editmessagereq-16136178d0.md): - [S3PresignedMultiResp](https://apispecs.chatenium.hu/s3presignedmultiresp-16136179d0.md): - [S3FinishMultiReq](https://apispecs.chatenium.hu/s3finishmultireq-16136180d0.md): - [FileMetadata](https://apispecs.chatenium.hu/filemetadata-16136181d0.md): - [StartNewReq](https://apispecs.chatenium.hu/startnewreq-16136182d0.md): - [StartNewResp](https://apispecs.chatenium.hu/startnewresp-16136183d0.md): - [RTCConfiguration](https://apispecs.chatenium.hu/rtcconfiguration-16136184d0.md): - [RTCSendOfferReq](https://apispecs.chatenium.hu/rtcsendofferreq-16136185d0.md): - [RTCSendAnswerReq](https://apispecs.chatenium.hu/rtcsendanswerreq-16136186d0.md): - [RTCSendCandidateReq](https://apispecs.chatenium.hu/rtcsendcandidatereq-16136187d0.md): - [CompletePicUploadReq](https://apispecs.chatenium.hu/completepicuploadreq-16136188d0.md): - [Cascade](https://apispecs.chatenium.hu/cascade-16136189d0.md): - [CreateCascadeReq](https://apispecs.chatenium.hu/createcascadereq-16136190d0.md): - [Ban](https://apispecs.chatenium.hu/ban-16136191d0.md): - [DiscoveryCascade](https://apispecs.chatenium.hu/discoverycascade-16136192d0.md): - [JoinFromInviteReq](https://apispecs.chatenium.hu/joinfrominvitereq-16136193d0.md): - [JoinPublicReq](https://apispecs.chatenium.hu/joinpublicreq-16136194d0.md): - [EditNameReq](https://apispecs.chatenium.hu/editnamereq-16136195d0.md): - [ChangeVisibility](https://apispecs.chatenium.hu/changevisibility-16136196d0.md): - [Thread](https://apispecs.chatenium.hu/thread-16136197d0.md): - [StartNewThreadReq](https://apispecs.chatenium.hu/startnewthreadreq-16136198d0.md): - [ThreadMessageAttachment](https://apispecs.chatenium.hu/threadmessageattachment-16136199d0.md): - [ThreadMessage](https://apispecs.chatenium.hu/threadmessage-16136200d0.md): - [TMSendMessageReq](https://apispecs.chatenium.hu/tmsendmessagereq-16136201d0.md): - [TMPinMessageReq](https://apispecs.chatenium.hu/tmpinmessagereq-16136202d0.md): - [TMGetPositionResp](https://apispecs.chatenium.hu/tmgetpositionresp-16136203d0.md): - [TMEditMessageReq](https://apispecs.chatenium.hu/tmeditmessagereq-16136204d0.md): - [UnOrFollowCreatorReq](https://apispecs.chatenium.hu/unorfollowcreatorreq-16136205d0.md): - [Creator](https://apispecs.chatenium.hu/creator-16136206d0.md): - [ToggleDiscoveryParticipationReq](https://apispecs.chatenium.hu/togglediscoveryparticipationreq-16136207d0.md): - [Picture](https://apispecs.chatenium.hu/picture-16136208d0.md): - [UploadPicturesReq](https://apispecs.chatenium.hu/uploadpicturesreq-16136209d0.md): - [EditPictureReq](https://apispecs.chatenium.hu/editpicturereq-16136210d0.md): - [LikePictureReq](https://apispecs.chatenium.hu/likepicturereq-16136211d0.md): - [DiscoveryResp](https://apispecs.chatenium.hu/discoveryresp-16136212d0.md): - [Comment](https://apispecs.chatenium.hu/comment-16136213d0.md): - [PostCommentReq](https://apispecs.chatenium.hu/postcommentreq-16136214d0.md): - [EditCommentReq](https://apispecs.chatenium.hu/editcommentreq-16136215d0.md): - [Preview](https://apispecs.chatenium.hu/preview-16136216d0.md): - [Album](https://apispecs.chatenium.hu/album-16136217d0.md): - [CreateAlbumReq](https://apispecs.chatenium.hu/createalbumreq-16136218d0.md): - [EditAlbumReq](https://apispecs.chatenium.hu/editalbumreq-16136219d0.md):