Chat-Public API | API Documentation

Authentication

Chat-Public endpoints require the chat key in Bearer format.

Reference

JSON

{
  "Content-Type": "application/json",
  "Authorization": "Bearer {{chatKey}}"
}

Get Messages

Retrieve all chat messages for a conversation context.

Reference

GET/api/v1/chat/message

Sample Response (200)

JSON

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "conversationId": "uuid",
      "role": "ASSISTANT",
      "content": "Message from the assistant",
      "createdAt": "ISO timestamp",
      "updatedAt": "ISO timestamp"
    },
    {
      "id": "uuid",
      "conversationId": "uuid",
      "role": "USER",
      "content": "This is the message content",
      "createdAt": "ISO timestamp",
      "updatedAt": "ISO timestamp"
    }
  ]
}

Field	Type	Optional	Nullable	Enums/Format	Description	Notes
success	boolean	false	false	-	Indicates request success	-
data	array	false	false	-	List of message objects	-

Send Message

Submit a user message and receive an assistant response payload.

Reference

POST/api/v1/chat/message

Request Body

JSON

{
  "message": "Message from the user",
  "clientId": "Client UUID"
}

Field	Type	Optional	Nullable	Enums/Format	Description	Notes
message	string	false	false	-	User message body	-
clientId	string (uuid)	false	false	UUID	Client identifier	-

Sample Response (200)

JSON

{
  "success": true,
  "message": "Message sent successfully",
  "data": {
    "chatKey": "chatKey",
    "message": {
      "id": "Assistant UUID",
      "conversationId": "UUID",
      "role": "ASSISTANT",
      "content": "Assistant reply",
      "createdAt": "ISO timestamp",
      "updatedAt": "ISO timestamp"
    }
  }
}

Field	Type	Optional	Nullable	Enums/Format	Description	Notes
success	boolean	false	false	-	Request status	-
message	string	false	false	-	Operation summary	-
data	object	false	false	-	Response payload	-
data.chatKey	string	false	false	-	Chat key	-
data.message	object	false	false	-	Assistant message object	-

Message Object Schema

Shared message shape used by Chat-Public responses.

Reference

Field	Type	Optional	Nullable	Enums/Format	Description	Notes
id	string (uuid)	false	false	UUID	Message ID	-
conversationId	string (uuid)	false	false	UUID	Conversation ID	-
role	string	false	false	USER, ASSISTANT	Sender role	-
content	string	false	false	-	Message content	-
createdAt	string	false	false	ISO 8601	Creation timestamp	-
updatedAt	string	false	false	ISO 8601	Update timestamp	-