Vector Upsert

Upsert vector embeddings

post

Upsert vector embeddings of documents in a chatflow

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Chatflow ID

Body

application/jsonmultipart/form-data

stopNodeIdstringOptional

In cases when you have multiple vector store nodes, you can specify the node ID to store the vectors

Example: node_1

overrideConfigobjectOptional

The configuration to override the default vector upsert settings (optional)

Responses

200

Vector embeddings upserted successfully

application/json

numAddednumberOptional

Number of vectors added

Example: 1

numDeletednumberOptional

Number of vectors deleted

Example: 1

numUpdatednumberOptional

Number of vectors updated

Example: 1

numSkippednumberOptional

Number of vectors skipped (not added, deleted, or updated)

Example: 1

400

Invalid input provided

404

Chatflow not found

422

Validation error

500

Internal server error

post

/vector/upsert/{id}

HTTPcURLJavaScriptPython

POST /vector/upsert/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "stopNodeId": "node_1",
  "overrideConfig": {}
}

application/jsonmultipart/form-data

{
  "numAdded": 1,
  "numDeleted": 1,
  "numUpdated": 1,
  "numSkipped": 1,
  "addedDocs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ]
}