Skip to main content
GET
/
v1
/
api
/
stores
/
{store_id}
Get Document Store By Id
curl --request GET \
  --url https://dev-knowledge-store.actualize.ae/v1/api/stores/{store_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "embedding": {
    "name": "<string>",
    "embeddingModel": "<string>"
  },
  "loaders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "type": "<string>",
        "location": "<string>",
        "metadata": {}
      },
      "parser": {
        "name": "<string>",
        "parserType": "pdf",
        "config": {}
      },
      "splitter": {
        "name": "<string>",
        "config": {}
      }
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": "EMPTY",
  "vectorStoreConfig": {},
  "recordManagerConfig": {},
  "totalChars": 0,
  "totalChunks": 0,
  "processResult": "<string>",
  "collectionName": "",
  "contentPayloadKey": "page_content",
  "metadataPayloadKey": "metadata",
  "userId": "<string>",
  "orgId": "<string>"
}

Path Parameters

​
store_id
string<uuid>
required

Response

Successful Response

A Document Store is a top-level entity that contains multiple documents.

​
id
string<uuid>
required

A unique ID for this Document Store

​
name
string
required

Name of the document store.

Minimum length: 1
​
description
string
required

Description of the document store.

Minimum length: 10
​
embedding
object
required

Embedding to use to vectorise the documents

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
loaders
DocumentLoaderResponse · object[]

List of document loaders linked to this store.

​
status
enum<string>
Available options:
EMPTY,
UPSERTED,
IN_PROGRESS,
FAILED
​
vectorStoreConfig
object | null
​
recordManagerConfig
object | null
​
totalChars
integer
default:0
​
totalChunks
integer
default:0
​
processResult
string | null
default:""

Failure message from processing the documents in the store (if any)

​
collectionName
string
default:""

Name of the Vector Store Collection in which the documents in this store as saved in.

​
contentPayloadKey
string
default:page_content

The name of the field which has the content in the vector store

​
metadataPayloadKey
string
default:metadata

The name of the field which has the metadata in the vector store

​
userId
string | null

The user who created the store

​
orgId
string | null

The organization which the store belongs to