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

Chatflows

GET /chatflows

List all chatflows

Retrieve a list of all chatflows

    <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">Successful operation</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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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></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>
POST /chatflows

Create a new chatflow

Create a new chatflow with the provided details

    <div class="api-body-section">
            <div class="api-request-body-section">
                <h4>Request Body (application/json)</h4>
                <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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
            </div>
        </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">Chatflow created successfully</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">Invalid input provided</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">422</span>
            <span class="api-response-desc">Validation exception</span>
            
        </div>
    </div></div>
</div>
GET /chatflows/{id}

Get chatflow by ID

Retrieve a specific chatflow by ID

    <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></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">Successful operation</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Chatflow 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>
PUT /chatflows/{id}

Update chatflow details

Update the details of an existing 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></div>
    <div class="api-body-section">
            <div class="api-request-body-section">
                <h4>Request Body (application/json)</h4>
                <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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
            </div>
        </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">Chatflow updated successfully</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid or body is missing</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Chatflow 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>
DELETE /chatflows/{id}

Delete a chatflow

Delete a chatflow by ID

    <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></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">Chatflow deleted successfully</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified ID is invalid</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Chatflow 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>
GET /chatflows/apikey/{apikey}

Get chatflow by API key

Retrieve a chatflow using an API key

    <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>apikey</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>API key associated with the chatflow</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">Successful operation</span>
            <div class="api-response-schema-toggle">Schema Detail:</div><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">name</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"MyChatFlow"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">flowData</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">deployed</span>
                    <span class="api-property-type">boolean</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">isPublic</span>
                    <span class="api-property-type">boolean</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">apikeyid</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">chatbotConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">apiConfig</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">analytic</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">speechToText</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"{}"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">category</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                
                <div class="api-property-example">Example: <code>"category1;category2"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">type</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">updatedDate</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>
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">400</span>
            <span class="api-response-desc">The specified API key is invalid</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">404</span>
            <span class="api-response-desc">Chatflow 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>