Document Store

PreviousChatflows NextFeedback

Last updated 19 days ago

Create a new document store

Creates a new document store with the provided details

post

/document-store/store

Authorizations

Body

idstring · uuid

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

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

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring · date-time

Date and time when the document store was created

updatedDatestring · date-time

Date and time when the document store was last updated

statusstring · enum

Status of the document store

Options: EMPTY, SYNC, SYNCING, STALE, NEW, UPSERTING, UPSERTED

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/document-store/store' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"status":"EMPTY"}'

200

400

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-02-21T18:03:03.282Z",
  "updatedDate": "2025-02-21T18:03:03.282Z",
  "status": "EMPTY"
}

Successfully created document store

List all document stores

Retrieves a list of all document stores

get

/document-store/store

Authorizations

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/document-store/store' \
  --header 'Authorization: Bearer JWT'

200

500

content

No body

A list of document stores

Get a specific document store

Retrieves details of a specific document store by its ID

get

/document-store/store/{id}

Authorizations

Path parameters

idstring · uuidrequired

Document store ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/document-store/store/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-02-21T18:03:03.282Z",
  "updatedDate": "2025-02-21T18:03:03.282Z",
  "status": "EMPTY"
}

Successfully retrieved document store

Update a specific document store

Updates the details of a specific document store by its ID

put

/document-store/store/{id}

Authorizations

Path parameters

idstring · uuidrequired

Document store ID

Body

idstring · uuid

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

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

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring · date-time

Date and time when the document store was created

updatedDatestring · date-time

Date and time when the document store was last updated

statusstring · enum

Status of the document store

Options: EMPTY, SYNC, SYNCING, STALE, NEW, UPSERTING, UPSERTED

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/document-store/store/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"status":"EMPTY"}'

200

404

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-02-21T18:03:03.282Z",
  "updatedDate": "2025-02-21T18:03:03.282Z",
  "status": "EMPTY"
}

Successfully updated document store

Delete a specific document store

Deletes a document store by its ID

delete

/document-store/store/{id}

Authorizations

Path parameters

idstring · uuidrequired

Document store ID

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/document-store/store/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

No body

Successfully deleted document store

Retrieval query

Retrieval query for the upserted chunks

post

/document-store/vectorstore/query

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/document-store/vectorstore/query' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"storeId":"603a7b51-ae7c-4b0a-8865-e454ed2f6766","query":"What is the capital of France?"}'

200

400

500

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

Successfully executed query on vector store

Delete data from vector store

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

delete

/document-store/vectorstore/{id}

Authorizations

Path parameters

idstringrequired

Document Store ID

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/document-store/vectorstore/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

No body

Successfully deleted data from vector store

Re-process and upsert all documents in document store

Re-process and upsert all existing documents in document store

post

/document-store/refresh/{id}

Authorizations

Path parameters

idstring · uuidrequired

Document Store ID

Body

itemsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/document-store/refresh/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"items":[{"metadata":{"foo":"bar"},"loader":{"name":"plainText","config":{}},"splitter":{"name":"recursiveCharacterTextSplitter","config":{}},"embedding":{"name":"openAIEmbeddings","config":{}},"vectorStore":{"name":"faiss","config":{}},"recordManager":{"name":"postgresRecordManager","config":{}}}]}'

200

400

500

No body

Successfully execute refresh operation

Delete specific document loader and associated chunks from document store

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

delete

/document-store/loader/{storeId}//{loaderId}

Authorizations

Path parameters

storeIdstringrequired

Document Store ID

loaderIdstringrequired

Document Loader ID

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/document-store/loader/{storeId}/{loaderId}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

No body

Successfully deleted loader from document store

Get chunks from a specific document loader

Get chunks from a specific document loader within a document store

get

/document-store/chunks/{storeId}//{loaderId}//{pageNo}

Authorizations

Path parameters

storeIdstring · uuidrequired

Document Store ID

loaderIdstring · uuidrequired

Document loader ID

pageNostringrequired

Pagination number

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/document-store/chunks/{storeId}/{loaderId}/{pageNo}' \
  --header 'Authorization: Bearer JWT'

200

404

500

{
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "loaderConfig": {},
    "splitterId": "text",
    "splitterName": "text",
    "splitterConfig": {},
    "totalChunks": 1,
    "totalChars": 1,
    "storeId": "text",
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1,
    "status": "EMPTY",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 1,
        "uploaded": "2025-02-21T18:03:03.282Z",
        "status": "EMPTY"
      }
    ]
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text",
  "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"
    }
  ]
}

Successfully retrieved chunks from document loader

Update a specific chunk

Updates a specific chunk from a document loader

put

/document-store/chunks/{storeId}//{loaderId}//{chunkId}

Authorizations

Path parameters

storeIdstringrequired

Document Store ID

loaderIdstringrequired

Document Loader ID

chunkIdstringrequired

Document Chunk ID

Body

pageContentstring

Example: This is the content of the page.

metadataobject

Example: {"author":"John Doe","date":"2024-08-24"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/document-store/chunks/{storeId}/{loaderId}/{chunkId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"pageContent":"This is the content of the page.","metadata":{"author":"John Doe","date":"2024-08-24"}}'

200

404

500

{
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "loaderConfig": {},
    "splitterId": "text",
    "splitterName": "text",
    "splitterConfig": {},
    "totalChunks": 1,
    "totalChars": 1,
    "storeId": "text",
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1,
    "status": "EMPTY",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 1,
        "uploaded": "2025-02-21T18:03:03.282Z",
        "status": "EMPTY"
      }
    ]
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text",
  "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"
    }
  ]
}

Successfully updated chunk

Delete a specific chunk from a document loader

delete

/document-store/chunks/{storeId}//{loaderId}//{chunkId}

Authorizations

Path parameters

storeIdstringrequired

Document Store ID

loaderIdstringrequired

Document Loader ID

chunkIdstringrequired

Document Chunk ID

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/document-store/chunks/{storeId}/{loaderId}/{chunkId}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

No body

Successfully deleted chunk

Upsert document to document store

post

/document-store/upsert/{id}

Authorizations

Path parameters

idstring · uuidrequired

Document Store ID

Body

docIdstring · uuid | nullable

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

replaceExistingboolean | nullable

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

createNewDocStoreboolean | nullable

Whether to create a new document store

metadataobject | nullable

Metadata associated with the document

Example: {"foo":"bar"}

docStoreobject | nullable

Only when createNewDocStore is true, pass in the new document store configuration

loaderobject | nullable

splitterobject | nullable

embeddingobject | nullable

vectorStoreobject | nullable

recordManagerobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/document-store/upsert/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"metadata":{"foo":"bar"},"docStore":{"name":"plainText","description":"plainText"},"loader":{"name":"plainText","config":{}},"splitter":{"name":"recursiveCharacterTextSplitter","config":{}},"embedding":{"name":"openAIEmbeddings","config":{}},"vectorStore":{"name":"faiss","config":{}},"recordManager":{"name":"postgresRecordManager","config":{}}}'

200

400

500

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

Successfully execute upsert operation