Home

Introduction

Welcome to the Chill&chat API documentation, This documentation will have the information about the API endpoints and how to call each of the endpoints using Javascript. You may use the index below to navigate the documentation. After every major release the documentation will be updated to the latest version.

Contents

• Login endpoint
• Block user endpoint
• Create room endpoint
• Delete user endpoint
• Get all rooms endpoint
• Get GIF endpoint
• Get messages endpoint
• Get public rooms endpoint
• Get user info endpoint
• Get users info endpoint(Deprecated)
• Join room endpoint
• Signup endpoint
• Report room endpoint
• Remove room endpoint
• Update description endpoint
• Follow user endpoint
• Unfollow user endpoint
• Update icon color endpoint
• Upload content endpoint
• Verify client endpoint
• Upload token endpoint
• Chill&chat websockets
• Message socket
• Keyboard socket
• Delete message socket
• User content
• Final words&thoughts
• Run API

Required knowledge

To read this documentation comfortably, we expect you to know how to read English; Programming concepts like Backend, frontend, API and some technical words on backend programming.

Using the documentation

This documentation can be used to get all the API information to be used in your programs. Every endpoint will have an example code snippet, you are welcome to copy and paste it into your program. Furthermore, the example snippets are written in Javascript and will be using the fetch/post functions to send requests to the server.

Contribution

Chill&chat is open and free software, we would love for you to contribute to the Chill&chat API or the documentation, to contribute please submit a pull request or an issue.