Paramus API Reference

Overview of the REST API for managing chats and dialogs in Paramus.

Documentation Index or back to Homepage

Servers

  • Local Server: http://localhost:8050 (adjust port if necessary)

Endpoints

GET /api/chats

OperationId: getChats

Summary: Retrieve all chats

Description: Retrieves a JSON array of all chat objects from the dialog table.

Responses
Status Code Description Response Schema
200 A JSON array of chat objects.
[
  {
    "id": "string",
    "chatName": "string",
    "numMessages": 0,
    "created": "date-time",
    "updated": "date-time",
    "GUID": "string"
  },
  ...
]
500 Server error.

GET /api/dialog

OperationId: getDialog

Summary: Retrieve a single dialog

Description: Retrieves a single dialog using the provided dialog ID as a query parameter.

Parameters
Name In Type Required Description
id query string true The dialog ID to retrieve.
Responses
Status Code Description Response Schema
200 A dialog object.
{
  "id": "string",
  "chatName": "string",
  "messages": [
    { /* message object details */ }
  ],
  "created": "date-time",
  "updated": "date-time",
  "GUID": "string"
}
400 Bad Request - No dialog id specified.
404 Dialog not found.
500 Server error.