chat

Get chat messages

Returns paginated messages for a chat with optional before/after cursor for time-based pagination.

GET/api/chat/projects/{projectId}/chats/{chatId}/messages

Authentication

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

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID.
chatIdstringYesChat ID.

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number (1-based).
limitintegerNoNumber of messages per page.
beforestringNoReturn messages before this timestamp (cursor).
afterstringNoReturn messages after this timestamp (cursor).

SDK setup

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

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

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

const result = await client.chat.getMessages({
  projectId: "proj_Q7JYXMrnqCe0",
  chatId: "AhAKtetS97NGkRXf"
});
const result = await client.chat.getMessages({
  projectId: "proj_Q7JYXMrnqCe0",
  chatId: "AhAKtetS97NGkRXf"
});

Try It 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

Responses

200Messages list
json
{
  "success": true,
  "data": {
    "messages": [
      {
        "_id": "65a1b2c3d4e5f6789012345g",
        "content": "Hello everyone",
        "sender": {
          "_id": "65a1b2c3d4e5f6789012345",
          "firstName": "John"
        },
        "createdAt": "2024-01-15T10:00:00.000Z"
      }
    ],
    "total": 1
  }
}
{
  "success": true,
  "data": {
    "messages": [
      {
        "_id": "65a1b2c3d4e5f6789012345g",
        "content": "Hello everyone",
        "sender": {
          "_id": "65a1b2c3d4e5f6789012345",
          "firstName": "John"
        },
        "createdAt": "2024-01-15T10:00:00.000Z"
      }
    ],
    "total": 1
  }
}
401Authentication required or invalid token.

Errors

CodeMeaning
401Authentication required or invalid token.
Edit this page on GitHub