Skip to main content
PUT
/
v1
/
api
/
stores
/
{store_id}
/
document_loaders
/
{document_loader_id}
Update Document Loader
curl --request PUT \
  --url https://dev-knowledge-store.actualize.ae/v1/api/stores/{store_id}/document_loaders/{document_loader_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parser": {
    "name": "<string>",
    "parserType": "pdf",
    "config": {}
  },
  "splitter": {
    "name": "<string>",
    "config": {}
  }
}
'
{
  "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": {}
  }
}

Path Parameters

document_loader_id
string<uuid>
required

Body

application/json

Request payload to create a new document loader.

name
string
required

Name for the document loader.

Minimum length: 1
description
string
required

Description of the document loader.

Minimum length: 10
documentId
string<uuid>
required

The ID of the document this document loader will load.

parser
object
required

The loader that will load the document associated with this document loader, with its configuration.

splitter
object
required

The text splitter that will split the document, along with its required configuration.

Response

Successful Response

Response payload for a document loader.

id
string<uuid>
required
name
string
required

Name for the document loader.

Minimum length: 1
description
string
required

Description of the document loader.

Minimum length: 10
storeId
string<uuid>
required

The Document Store which contains this Document Loader

document
object
required

The document this Document Loader will load

parser
object
required

The parser (loader) to use to load the document

splitter
object
required

The splitter to be used to split the loaded document