FlowiseAI
Español
Español
  • Introduction
  • Partes
    • Parte 1: Introducción
      • Recursos
    • Parte 2: Chains Avanzadas
      • Desafío 1: Traductor de Lenguas Antiguas
    • Parte 3: Gestión de Documentos y Memoria
      • Desafío 2: Chatbot Nikola Tesla
    • Parte 4: Despliegue y API
    • Parte 5: Introducción a Agentes
      • Desafíos
    • Parte 6: Agentes Avanzados
      • Desafíos
    • Parte 7: Multi-Agentes
      • Desafíos
    • Parte 8: AgentFlows
      • Desafíos
    • Parte 9: Agentes Secuenciales
      • Desafíos
    • Parte 10: Sequential Agents Avanzados
  • Recursos
    • Enlaces Útiles
    • Documentación Oficial
    • Ejemplos de Código
    • Mejores Prácticas
  • Documentación Oficial
    • Introduction
    • Primeros Pasos
    • Guía de Contribución
      • Building Node
    • Referencia de API
      • Assistants
      • Attachments
      • Chat Message
      • Chatflows
      • Document Store
      • Feedback
      • Leads
      • Ping
      • Prediction
      • Tools
      • Upsert History
      • Variables
      • Vector Upsert
    • Usar Flowise
      • Agentflows
        • Multi-Agents
        • Sequential Agents
          • Tutoriales en Video
      • API
      • Analytic
      • Almacenes de Documentos
      • Embed
      • Monitoring
      • Streaming
      • Telemetry
      • Subidas
      • Variables
      • Workspaces
      • Evaluaciones
    • Configuración
      • Auth
        • Nivel de App
        • Nivel de Chatflow
      • Databases
      • Deployment
        • AWS
        • Azure
        • Alibaba Cloud
        • Digital Ocean
        • Elestio
        • GCP
        • Hugging Face
        • Kubernetes using Helm
        • Railway
        • Render
        • Replit
        • RepoCloud
        • Sealos
        • Zeabur
      • Variables de Entorno
      • Rate Limit
      • Ejecutar Flowise detrás de proxy corporativo
      • SSO
    • Integraciones
      • LangChain
        • Agents
          • Airtable Agent
          • AutoGPT
          • BabyAGI
          • CSV Agent
          • Conversational Agent
          • Conversational Retrieval Agent
          • MistralAI Tool Agent
          • OpenAI Assistant
            • Threads
          • OpenAI Function Agent
          • OpenAI Tool Agent
          • ReAct Agent Chat
          • ReAct Agent LLM
          • Tool Agent
          • XML Agent
        • Cache
          • InMemory Cache
          • InMemory Embedding Cache
          • Momento Cache
          • Redis Cache
          • Redis Embeddings Cache
          • Upstash Redis Cache
        • Chains
          • GET API Chain
          • OpenAPI Chain
          • POST API Chain
          • Conversation Chain
          • Conversational Retrieval QA Chain
          • LLM Chain
          • Multi Prompt Chain
          • Multi Retrieval QA Chain
          • Retrieval QA Chain
          • Sql Database Chain
          • Vectara QA Chain
          • VectorDB QA Chain
        • Chat Models
          • AWS ChatBedrock
          • Azure ChatOpenAI
          • NVIDIA NIM
          • ChatAnthropic
          • ChatCohere
          • Chat Fireworks
          • ChatGoogleGenerativeAI
          • Google VertexAI
          • ChatHuggingFace
          • ChatLocalAI
          • ChatMistralAI
          • IBM Watsonx
          • ChatOllama
          • ChatOpenAI
          • ChatTogetherAI
          • GroqChat
        • Document Loaders
          • API Loader
          • Airtable
          • Apify Website Content Crawler
          • Cheerio Web Scraper
          • Confluence
          • Csv File
          • Custom Document Loader
          • Document Store
          • Docx File
          • File Loader
          • Figma
          • FireCrawl
          • Folder with Files
          • GitBook
          • Github
          • Json File
          • Json Lines File
          • Notion Database
          • Notion Folder
          • Notion Page
          • PDF Files
          • Plain Text
          • Playwright Web Scraper
          • Puppeteer Web Scraper
          • S3 File Loader
          • SearchApi For Web Search
          • SerpApi For Web Search
          • Spider Web Scraper/Crawler
          • Text File
          • Unstructured File Loader
          • Unstructured Folder Loader
          • VectorStore To Document
        • Embeddings
          • AWS Bedrock Embeddings
          • Azure OpenAI Embeddings
          • Cohere Embeddings
          • Google GenerativeAI Embeddings
          • Google VertexAI Embeddings
          • HuggingFace Inference Embeddings
          • LocalAI Embeddings
          • MistralAI Embeddings
          • Ollama Embeddings
          • OpenAI Embeddings
          • OpenAI Embeddings Custom
          • TogetherAI Embedding
          • VoyageAI Embeddings
        • LLMs
          • AWS Bedrock
          • Azure OpenAI
          • Cohere
          • GoogleVertex AI
          • HuggingFace Inference
          • Ollama
          • OpenAI
          • Replicate
        • Memory
          • Buffer Memory
          • Buffer Window Memory
          • Conversation Summary Memory
          • Conversation Summary Buffer Memory
          • DynamoDB Chat Memory
          • MongoDB Atlas Chat Memory
          • Redis-Backed Chat Memory
          • Upstash Redis-Backed Chat Memory
          • Zep Memory
        • Moderation
          • OpenAI Moderation
          • Simple Prompt Moderation
        • Output Parsers
          • CSV Output Parser
          • Custom List Output Parser
          • Structured Output Parser
          • Advanced Structured Output Parser
        • Prompts
          • Chat Prompt Template
          • Few Shot Prompt Template
          • Prompt Template
        • Record Managers
        • Retrievers
          • Custom Retriever
          • Cohere Rerank Retriever
          • Embeddings Filter Retriever
          • HyDE Retriever
          • LLM Filter Retriever
          • Multi Query Retriever
          • Prompt Retriever
          • Reciprocal Rank Fusion Retriever
          • Similarity Score Threshold Retriever
          • Vector Store Retriever
          • Voyage AI Rerank Retriever
        • Text Splitters
          • Character Text Splitter
          • Code Text Splitter
          • Html-To-Markdown Text Splitter
          • Markdown Text Splitter
          • Recursive Character Text Splitter
          • Token Text Splitter
        • Tools
          • BraveSearch API
          • Calculator
          • Chain Tool
          • Chatflow Tool
          • Custom Tool
          • Exa Search
          • Google Custom Search
          • OpenAPI Toolkit
          • Code Interpreter by E2B
          • Read File
          • Request Get
          • Request Post
          • Retriever Tool
          • SearchApi
          • SearXNG
          • Serp API
          • Serper
          • Web Browser
          • Write File
        • Vector Stores
          • AstraDB
          • Chroma
          • Elastic
          • Faiss
          • In-Memory Vector Store
          • Milvus
          • MongoDB Atlas
          • OpenSearch
          • Pinecone
          • Postgres
          • Qdrant
          • Redis
          • SingleStore
          • Supabase
          • Upstash Vector
          • Vectara
          • Weaviate
          • Zep Collection - Open Source
          • Zep Collection - Cloud
      • LiteLLM Proxy
      • LlamaIndex
        • Agents
          • OpenAI Tool Agent
          • Anthropic Tool Agent
        • Chat Models
          • AzureChatOpenAI
          • ChatAnthropic
          • ChatMistral
          • ChatOllama
          • ChatOpenAI
          • ChatTogetherAI
          • ChatGroq
        • Embeddings
          • Azure OpenAI Embeddings
          • OpenAI Embedding
        • Engine
          • Query Engine
          • Simple Chat Engine
          • Context Chat Engine
          • Sub-Question Query Engine
        • Response Synthesizer
          • Refine
          • Compact And Refine
          • Simple Response Builder
          • Tree Summarize
        • Tools
          • Query Engine Tool
        • Vector Stores
          • Pinecone
          • SimpleStore
      • Utilities
        • Custom JS Function
        • Set/Get Variable
        • If Else
        • Sticky Note
      • External Integrations
        • Zapier Zaps
    • Migration Guide
      • v1.3.0 Migration Guide
      • v1.4.3 Migration Guide
      • v2.1.4 Migration Guide
    • Use Cases
      • Calling Children Flows
      • Calling Webhook
      • Interacting with API
      • Multiple Documents QnA
      • SQL QnA
      • Upserting Data
      • Web Scrape QnA
  • Flowise
    • Flowise GitHub
    • Flowise Cloud
Powered by GitBook
On this page
Edit on GitHub
  1. Documentación Oficial
  2. Referencia de API

Document Store

PreviousChatflowsNextFeedback

Last updated 3 months ago

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

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-15T11:10:02.335Z",
  "updatedDate": "2025-05-15T11:10:02.335Z"
}

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-15T11:10:02.335Z",
  "updatedDate": "2025-05-15T11:10:02.335Z"
}
{
  "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-15T11:10:02.335Z",
  "updatedDate": "2025-05-15T11:10:02.335Z"
}

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-15T11:10:02.335Z",
  "updatedDate": "2025-05-15T11:10:02.335Z"
}
{
  "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-15T11:10:02.335Z",
  "updatedDate": "2025-05-15T11:10:02.335Z"
}

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"
      }
    }
  ]
}
  • POSTCreate a new document store
  • GETList all document stores
  • GETGet a specific document store
  • PUTUpdate a specific document store
  • DELETEDelete a specific document store
  • POSTUpsert document to document store
  • POSTRe-process and upsert all documents in document store
  • POSTRetrieval query
  • DELETEDelete specific document loader and associated chunks from document store
  • DELETEDelete data from vector store
  • GETGet chunks from a specific document loader
  • PUTUpdate a specific chunk
  • DELETEDelete a specific chunk from a document loader

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

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

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

No content

DELETE /document-store/loader/{storeId}/{loaderId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
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-15T11:10:02.335Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}

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-15T11:10:02.335Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}
DELETE /document-store/chunks/{storeId}/{loaderId}/{chunkId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*