Skip to main content
GET
/
api
/
v1
/
document-store
/
store
List Document Stores
curl --request GET \
  --url https://api.example.com/api/v1/document-store/store
{
  "401": {},
  "403": {},
  "404": {},
  "412": {},
  "500": {},
  "total": 123,
  "data": [
    {}
  ],
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "loaders": [
    {}
  ],
  "whereUsed": "<string>",
  "status": "<string>",
  "vectorStoreConfig": {},
  "embeddingConfig": {},
  "recordManagerConfig": {},
  "createdDate": {},
  "updatedDate": {},
  "workspaceId": "<string>"
}
Retrieve all document stores in your workspace. Document stores manage collections of documents with vector embeddings for retrieval.

​
Query Parameters

​
page
number
Page number for pagination. Default: 1
​
limit
number
Number of results per page. Default: 50

​
Response

​
total
number
Total number of document stores
​
data
array
Array of document store objects

​
Document Store Object

​
id
string
Unique identifier for the document store
​
name
string
Name of the document store
​
description
string
Description of the document store
​
loaders
array
Array of document loaders configured for this store
​
whereUsed
string
JSON string of flows using this document store
​
status
string
Current status (e.g., SYNC, STALE, NEW)
​
vectorStoreConfig
object
Configuration for the vector store
​
embeddingConfig
object
Configuration for embeddings
​
recordManagerConfig
object
Configuration for record management
​
createdDate
timestamp
When the document store was created
​
updatedDate
timestamp
When the document store was last updated
​
workspaceId
string
ID of the workspace containing this store

​
Example Request

curl -X GET \
  'https://your-flowise-instance.com/api/v1/document-store/store' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Example Request - With Pagination

curl -X GET \
  'https://your-flowise-instance.com/api/v1/document-store/store?page=1&limit=10' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Example Response

{
  "total": 2,
  "data": [
    {
      "id": "store-123",
      "name": "Product Documentation",
      "description": "All product documentation and guides",
      "loaders": [
        {
          "id": "loader-001",
          "loaderId": "pdfLoader",
          "status": "SYNC",
          "totalChunks": 150
        }
      ],
      "whereUsed": "[{\"id\":\"flow-1\",\"name\":\"Support Bot\"}]",
      "status": "SYNC",
      "vectorStoreConfig": {
        "provider": "pinecone",
        "indexName": "product-docs"
      },
      "embeddingConfig": {
        "provider": "openai",
        "model": "text-embedding-ada-002"
      },
      "createdDate": "2024-01-15T10:30:00Z",
      "updatedDate": "2024-01-20T14:45:00Z",
      "workspaceId": "workspace-123"
    }
  ]
}

​
Document Store Status

  • NEW - Newly created, no documents uploaded yet
  • SYNC - All documents are synced to vector store
  • STALE - Documents need to be re-synced
  • SYNCING - Currently syncing documents
  • ERROR - Error occurred during sync

​
Error Responses

​
401
error
Unauthorized - Invalid or missing API key
​
403
error
Forbidden - Insufficient permissions to view document stores
​
404
error
Not Found - Workspace not found
​
412
error
Precondition Failed - Workspace ID not provided
​
500
error
Internal Server Error - Error retrieving document stores

Build docs developers (and LLMs) love

Get started for freeTalk to us