Document Store

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

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/document-store/store' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "loaders": "text",
    "whereUsed": "text",
    "status": "EMPTY",
    "vectorStoreConfig": "text",
    "embeddingConfig": "text",
    "recordManagerConfig": "text",
    "createdDate": "2025-03-25T23:44:08.754Z",
    "updatedDate": "2025-03-25T23:44:08.754Z"
  }'

200

400

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-03-25T23:44:08.754Z",
  "updatedDate": "2025-03-25T23:44:08.754Z"
}

Successfully created document store

List all document stores

get

Retrieves a list of all document stores

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

500

content

200

No body

A list of document stores

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-03-25T23:44:08.754Z",
  "updatedDate": "2025-03-25T23:44:08.754Z"
}

Successfully retrieved document store

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

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

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/document-store/store/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "loaders": "text",
    "whereUsed": "text",
    "status": "EMPTY",
    "vectorStoreConfig": "text",
    "embeddingConfig": "text",
    "recordManagerConfig": "text",
    "createdDate": "2025-03-25T23:44:08.754Z",
    "updatedDate": "2025-03-25T23:44:08.754Z"
  }'

200

404

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2025-03-25T23:44:08.754Z",
  "updatedDate": "2025-03-25T23:44:08.754Z"
}

Successfully updated document store

Delete a specific document store

delete

Deletes a document store by its ID

Authorizations

Path parameters

idstring · uuidrequired

Document store ID

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

404

500

200

No body

Successfully deleted document store

Upsert document to document store

post

Upsert document to document store

Authorizations

Path parameters

idstring · uuidrequired

Document Store ID

Body

application/jsonmultipart/form-data

docIdstring · uuid | nullableoptional

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

metadataobject | nullableoptional

Metadata associated with the document

Example: {"foo":"bar"}

replaceExistingboolean | nullableoptional

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

createNewDocStoreboolean | nullableoptional

Whether to create a new document store

docStoreobject | nullableoptional

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

loaderobject | nullableoptional

splitterobject | nullableoptional

embeddingobject | nullableoptional

vectorStoreobject | nullableoptional

recordManagerobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/document-store/upsert/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "docId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "foo": "bar"
    },
    "replaceExisting": true,
    "createNewDocStore": true,
    "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": {}
    }
  }'

application/jsonmultipart/form-data

200

400

500

200

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

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

itemsobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/document-store/refresh/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {}
        }
      }
    ]
  }'

200

400

500

200

No body

Successfully execute refresh operation

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

No body

Successfully deleted loader from document store

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

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

No body

Successfully deleted data from vector store

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

500

200

{
  "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-03-25T23:44:08.754Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}

Successfully retrieved chunks from document loader

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

pageContentstringoptional

Example: This is the content of the page.

metadataobjectoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

{
  "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-03-25T23:44:08.754Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": true,
    "preview": true,
    "previewChunkCount": 1
  },
  "currentPage": 1,
  "storeName": "text",
  "description": "text"
}

Successfully updated chunk

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

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

No body

Successfully deleted chunk