BREAGEN Logo
Document Understanding

Conversation Management

Get Messages By User GET /v1/api/conversation

Resource URL/v1/api/conversation/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Retrieve messages associated with a specific user, with optional pagination and filtering by document or collection.

Parameters

ParameterDescriptionRequiredTypeDefault Value
userIdentifier of the userYesStringN/A
pagePage number for paginationNoInteger1
page_sizeNumber of messages per pageNoInteger10
document_idFilter by document ID (optional)NoString or NullN/A
collection_idFilter by collection ID (optional)NoString or NullN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/conversation/?user=jane.smith&page=1&page_size=5&document_id=doc_001' \
-H 'accept: application/json'

Example Request

{
    "is_error": false,
    "message": "Messages retrieved successfully",
    "results": {
        "user": "jane.smith",
        "messages": [
            {
                "id": "msg_001",
                "content": "Hello, how can I assist you?",
                "timestamp": "2025-04-07T10:00:00Z"
            },
            {
                "id": "msg_002",
                "content": "Please review document doc_001.",
                "timestamp": "2025-04-07T10:05:00Z"
            }
        ],
        "page": 1,
        "page_size": 5,
        "total": 2
    }
}

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

On this page