Document Store | FlowiseAI

FlowiseAI

Get a specific document store

get

Retrieves details of a specific document store by its ID

Authorizations

Path parameters

idstring · uuidRequired

Document store ID

Responses

200

Successfully retrieved document store

application/json

404

Document store not found

500

Internal server error

get

GET /document-store/store/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-05-21T13:43:24.577Z",
  "updatedDate": "2025-05-21T13:43:24.577Z"
}

Delete a specific document store

delete

Deletes a document store by its ID

Authorizations

Path parameters

idstring · uuidRequired

Document store ID

Responses

200

Successfully deleted document store

404

Document store not found

500

Internal server error

delete

DELETE /document-store/store/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Delete data from vector store

delete

Only data that were upserted with Record Manager will be deleted from vector store

Authorizations

Path parameters

idstringRequired

Document Store ID

Responses

200

Successfully deleted data from vector store

400

Invalid ID provided

404

Document Store not found

500

Internal server error

delete

DELETE /document-store/vectorstore/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

List all document stores

get

Retrieves a list of all document stores

Authorizations

Responses

200

A list of document stores

500

Internal server error

content

get

GET /document-store/store HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Create a new document store

post

Creates a new document store with the provided details

Authorizations

Body

idstring · uuidOptional

Unique identifier for the document store

namestringOptional

Name of the document store

descriptionstringOptional

Description of the document store

loadersstringOptional

Loaders associated with the document store, stored as JSON string

whereUsedstringOptional

Places where the document store is used, stored as JSON string

statusstring · enumOptional

Status of the document store

Possible values:

vectorStoreConfigstringOptional

Configuration for the vector store, stored as JSON string

embeddingConfigstringOptional

Configuration for the embedding, stored as JSON string

recordManagerConfigstringOptional

Configuration for the record manager, stored as JSON string

createdDatestring · date-timeOptional

Date and time when the document store was created

updatedDatestring · date-timeOptional

Date and time when the document store was last updated

Responses

200

Successfully created document store

application/json

400

Invalid request body

500

Internal server error

post

POST /document-store/store HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-05-21T13:43:24.577Z",
  "updatedDate": "2025-05-21T13:43:24.577Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-05-21T13:43:24.577Z",
  "updatedDate": "2025-05-21T13:43:24.577Z"
}

Update a specific document store

put

Updates the details of a specific document store by its ID

Authorizations

Path parameters

idstring · uuidRequired

Document store ID

Body

idstring · uuidOptional

Unique identifier for the document store

namestringOptional

Name of the document store

descriptionstringOptional

Description of the document store

loadersstringOptional

Loaders associated with the document store, stored as JSON string

whereUsedstringOptional

Places where the document store is used, stored as JSON string

statusstring · enumOptional

Status of the document store

Possible values:

vectorStoreConfigstringOptional

Configuration for the vector store, stored as JSON string

embeddingConfigstringOptional

Configuration for the embedding, stored as JSON string

recordManagerConfigstringOptional

Configuration for the record manager, stored as JSON string

createdDatestring · date-timeOptional

Date and time when the document store was created

updatedDatestring · date-timeOptional

Date and time when the document store was last updated

Responses

200

Successfully updated document store

application/json

404

Document store not found

500

Internal server error

put

PUT /document-store/store/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-05-21T13:43:24.577Z",
  "updatedDate": "2025-05-21T13:43:24.577Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-05-21T13:43:24.577Z",
  "updatedDate": "2025-05-21T13:43:24.577Z"
}

Retrieval query

post

Retrieval query for the upserted chunks

Authorizations

Body

storeIdstringRequired

Document store ID

Example: 603a7b51-ae7c-4b0a-8865-e454ed2f6766

querystringRequired

Query to search for

Example: What is the capital of France?

Responses

200

Successfully executed query on vector store

application/json

400

Invalid request body

500

Internal server error

post

POST /document-store/vectorstore/query HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "storeId": "603a7b51-ae7c-4b0a-8865-e454ed2f6766",
  "query": "What is the capital of France?"
}

{
  "timeTaken": 1,
  "docs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ]
}

Delete specific document loader and associated chunks from document store

delete

Delete specific document loader and associated chunks from document store. This does not delete data from vector store.

Authorizations

Path parameters

storeIdstringRequired

Document Store ID

loaderIdstringRequired

Document Loader ID

Responses

200

Successfully deleted loader from document store

400

Invalid ID provided

404

Document Store not found

500

Internal server error

delete

DELETE /document-store/loader/{storeId}/{loaderId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Get chunks from a specific document loader

get

Get chunks from a specific document loader within a document store

Authorizations

Path parameters

storeIdstring · uuidRequired

Document Store ID

loaderIdstring · uuidRequired

Document loader ID

pageNostringRequired

Pagination number

Responses

200

Successfully retrieved chunks from document loader

application/json

404

Document store not found

500

Internal server error

get

GET /document-store/chunks/{storeId}/{loaderId}/{pageNo} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "chunks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "docId": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "chunkNo": 1,
      "pageContent": "text",
      "metadata": "text"
    }
  ],
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "loaderConfig": {},
    "splitterId": "text",
    "splitterName": "text",
    "splitterConfig": {},
    "totalChunks": 1,
    "totalChars": 1,
    "status": "EMPTY",
    "storeId": "text",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 1,
        "status": "EMPTY",
        "uploaded": "2025-05-21T13:43:24.577Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}

Delete a specific chunk from a document loader

delete

Delete a specific chunk from a document loader

Authorizations

Path parameters

storeIdstringRequired

Document Store ID

loaderIdstringRequired

Document Loader ID

chunkIdstringRequired

Document Chunk ID

Responses

200

Successfully deleted chunk

400

Invalid ID provided

404

Document Store not found

500

Internal server error

delete

DELETE /document-store/chunks/{storeId}/{loaderId}/{chunkId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Upsert document to document store

post

Upsert document to document store

Authorizations

Path parameters

idstring · uuidRequired

Document Store ID

Body

docIdstring · uuidOptional

Document ID within the store. If provided, existing configuration from the document will be used for the new document

metadataobjectOptional

Metadata associated with the document

Example: {"foo":"bar"}

replaceExistingbooleanOptional

Whether to replace existing document loader with the new upserted chunks. However this does not delete the existing embeddings in the vector store

Responses

200

Successfully execute upsert operation

application/json

400

Invalid request body

500

Internal server error

post

POST /document-store/upsert/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "docId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "foo": "bar"
  },
  "replaceExisting": true,
  "loader": {
    "name": "plainText",
    "config": {}
  },
  "splitter": {
    "name": "recursiveCharacterTextSplitter",
    "config": {}
  },
  "embedding": {
    "name": "openAIEmbeddings",
    "config": {}
  },
  "vectorStore": {
    "name": "faiss",
    "config": {}
  },
  "recordManager": {
    "name": "postgresRecordManager",
    "config": {}
  }
}

{
  "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"
      }
    }
  ]
}

Re-process and upsert all documents in document store

post

Re-process and upsert all existing documents in document store

Authorizations

Path parameters

idstring · uuidRequired

Document Store ID

Body

Responses

200

Successfully execute refresh operation

application/json

400

Invalid request body

500

Internal server error

post

POST /document-store/refresh/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 371

{
  "items": [
    {
      "docId": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "foo": "bar"
      },
      "replaceExisting": true,
      "loader": {
        "name": "plainText",
        "config": {}
      },
      "splitter": {
        "name": "recursiveCharacterTextSplitter",
        "config": {}
      },
      "embedding": {
        "name": "openAIEmbeddings",
        "config": {}
      },
      "vectorStore": {
        "name": "faiss",
        "config": {}
      },
      "recordManager": {
        "name": "postgresRecordManager",
        "config": {}
      }
    }
  ]
}

No content

Update a specific chunk

put

Updates a specific chunk from a document loader

Authorizations

Path parameters

storeIdstringRequired

Document Store ID

loaderIdstringRequired

Document Loader ID

chunkIdstringRequired

Document Chunk ID

Body

pageContentstringOptionalExample: This is the content of the page.

Responses

200

Successfully updated chunk

application/json

404

Document store not found

500

Internal server error

put

PUT /document-store/chunks/{storeId}/{loaderId}/{chunkId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "pageContent": "This is the content of the page.",
  "metadata": {
    "author": "John Doe",
    "date": "2024-08-24"
  }
}

{
  "chunks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "docId": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "chunkNo": 1,
      "pageContent": "text",
      "metadata": "text"
    }
  ],
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "loaderConfig": {},
    "splitterId": "text",
    "splitterName": "text",
    "splitterConfig": {},
    "totalChunks": 1,
    "totalChars": 1,
    "status": "EMPTY",
    "storeId": "text",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 1,
        "status": "EMPTY",
        "uploaded": "2025-05-21T13:43:24.577Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}