Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Chat Message

GET /chatmessage/{id}

List all chat messages

Retrieve all chat messages for a specific chatflow.

    <div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Chatflow ID</td></tr></tbody></table><h4>Query Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>chatType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by chat type</td></tr><tr><td><strong>order</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Sort order</td></tr><tr><td><strong>chatId</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by chat ID</td></tr><tr><td><strong>memoryType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by memory type</td></tr><tr><td><strong>sessionId</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by session ID</td></tr><tr><td><strong>startDate</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by start date</td></tr><tr><td><strong>endDate</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by end date</td></tr><tr><td><strong>feedback</strong></td><td><code>boolean</code></td><td><span class="req-no">No</span></td><td>Filter by feedback</td></tr><tr><td><strong>feedbackType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by feedback type. Only applicable if feedback is true</td></tr></tbody></table></div>
    
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">A list of chat messages</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><div class="api-property-array">Array of: <div class="api-object-properties">
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">id</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0851"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">role</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"apiMessage"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">chatflowid</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"d290f1ee-6c54-4b01-90e6-d701748f0852"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">content</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"Hello, how can I help you today?"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">sourceDocuments</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">usedTools</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">fileAnnotations</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">agentReasoning</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">fileUploads</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">action</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">chatType</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"INTERNAL"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">chatId</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"chat12345"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">memoryType</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">sessionId</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">createdDate</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">leadEmail</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"user@example.com"</code></div>
            </div>
        </div></div>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>
DELETE /chatmessage/{id}

Delete all chat messages

Delete all chat messages for a specific chatflow.

    <div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Chatflow ID</td></tr></tbody></table><h4>Query Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>chatId</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by chat ID</td></tr><tr><td><strong>memoryType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by memory type</td></tr><tr><td><strong>sessionId</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by session ID</td></tr><tr><td><strong>chatType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by chat type</td></tr><tr><td><strong>startDate</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by start date</td></tr><tr><td><strong>endDate</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by end date</td></tr><tr><td><strong>feedbackType</strong></td><td><code>string</code></td><td><span class="req-no">No</span></td><td>Filter by feedback type</td></tr><tr><td><strong>hardDelete</strong></td><td><code>boolean</code></td><td><span class="req-no">No</span></td><td>If hardDelete is true, messages will be deleted from the third party service as well</td></tr></tbody></table></div>
    
    <div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
        <div class="api-response-row">
            <span class="api-response-code code-success">200</span>
            <span class="api-response-desc">Chat messages deleted successfully</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">Invalid parameters</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Chat messages not found</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal error</span>
            
        </div>
    </div></div>
</div>