Back to explore

messaging

Chat

Real time messaging

Introduction

The Chat service is a programmable instant messaging API service which can be used in any application to immediately create conversations.

Features

Create

Create a new chat room

Delete

Delete a chat room

History

List the messages in a chat

Invite

Invite a user to a chat room

Join

Join a chat room

Kick

Kick a user from a chat room

Leave

Leave a chat room

List

List available chats

Send

Connect to a chat to receive a stream of messages Send a message to a chat

Pricing

EndpointCreditsQuotas
CreateBaseNone
DeleteBaseNone
HistoryBaseNone
InviteBaseNone
JoinBaseNone
KickBaseNone
LeaveBaseNone
ListBaseNone
SendBaseNone

Base request price is 0.000001 credits per request

Get Started

Example

Create Request

Response

{
    "room": {
        "id": "d8057208-f81a-4e14-ad7f-c29daa2bb910",
        "name": "general",
        "description": "The general chat room",
        "created_at": "2022-02-17T16:12:43.942557998Z",
        "user_ids": [],
        "private": false
    }
}