Chat

Get chat details

AuthBearer (JWT)
GroupChat
Rate limitSee Rate Limits
GET/api/chat/projects/{projectId}/chats/{chatId}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, ChatApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const chat = new ChatApi(configuration);
import { Configuration, ChatApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const chat = new ChatApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await chat.getChatDetails("proj_6dCBd83E2A0F", "FX2horZSpWSggkP4");
const { data: result } = await chat.getChatDetails("proj_6dCBd83E2A0F", "FX2horZSpWSggkP4");

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYes
chatIdstringYes

Responses

200Chat details
json
{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "name": "Team Chat",
    "type": "group",
    "participants": [
      {
        "userId": "685acbe0e129932fbb7a0fc2",
        "role": "admin"
      }
    ],
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
{
  "success": true,
  "data": {
    "_id": "65a1b2c3d4e5f6789012345f",
    "name": "Team Chat",
    "type": "group",
    "participants": [
      {
        "userId": "685acbe0e129932fbb7a0fc2",
        "role": "admin"
      }
    ],
    "createdAt": "2024-01-15T10:00:00.000Z"
  }
}
401
404

Errors

CodeMeaning
401
404
Edit this page on GitHub