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

Vector Upsert

POST /vector/upsert/{id}

Upsert vector embeddings

Upsert vector embeddings of documents in a 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">stopNodeId</span>
                    <span class="api-property-type">string</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">In cases when you have multiple vector store nodes, you can specify the node ID to store the vectors</div>
                <div class="api-property-example">Example: <code>"node_1"</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">overrideConfig</span>
                    <span class="api-property-type">object</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">The configuration to override the default vector upsert settings (optional)</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">Vector embeddings upserted 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">numAdded</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">Number of vectors added</div>
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">numDeleted</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">Number of vectors deleted</div>
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">numUpdated</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">Number of vectors updated</div>
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">numSkipped</span>
                    <span class="api-property-type">number</span>
                    <span class="api-property-optional">optional</span>
                </div>
                <div class="api-property-desc">Number of vectors skipped (not added, deleted, or updated)</div>
                <div class="api-property-example">Example: <code>1</code></div>
            </div>
        
            <div class="api-property-row" style="margin-left: 0px;">
                <div class="api-property-meta">
                    <span class="api-property-name">addedDocs</span>
                    <span class="api-property-type">array</span>
                    <span class="api-property-optional">optional</span>
                </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">404</span>
            <span class="api-response-desc">Chatflow not found</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">422</span>
            <span class="api-response-desc">Validation error</span>
            
        </div>
    
        <div class="api-response-row">
            <span class="api-response-code code-error">500</span>
            <span class="api-response-desc">Internal server error</span>
            
        </div>
    </div></div>
</div>