Document Store
POST
/document-store/store
Create a new document store
Creates a new document store with the provided details
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loaders</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Loaders associated with the document store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">whereUsed</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Places where the document store is used, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStoreConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embeddingConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManagerConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was created</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">updatedDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was last updated</div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully created document store</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loaders</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Loaders associated with the document store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">whereUsed</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Places where the document store is used, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStoreConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embeddingConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManagerConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was created</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">updatedDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was last updated</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid request body</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
GET
/document-store/store
List all document stores
Retrieves a list of all document stores
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">A list of document stores</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">content</span>
<span class="api-response-desc"></span>
</div>
</div></div>
</div>
GET
/document-store/store/{id}
Get a specific document store
Retrieves details of a specific document store by its ID
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document store ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully retrieved document store</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loaders</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Loaders associated with the document store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">whereUsed</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Places where the document store is used, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStoreConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embeddingConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManagerConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was created</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">updatedDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was last updated</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
PUT
/document-store/store/{id}
Update a specific document store
Updates the details of a specific document store by its ID
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document store ID</td></tr></tbody></table></div>
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loaders</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Loaders associated with the document store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">whereUsed</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Places where the document store is used, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStoreConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embeddingConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManagerConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was created</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">updatedDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was last updated</div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully updated document store</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loaders</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Loaders associated with the document store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">whereUsed</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Places where the document store is used, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStoreConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embeddingConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManagerConfig</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager, stored as JSON string</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was created</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">updatedDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the document store was last updated</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
DELETE
/document-store/store/{id}
Delete a specific document store
Deletes a document store by its ID
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document store ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully deleted document store</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
POST
/document-store/upsert/{id}
Upsert document to document store
Upsert document to document store
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr></tbody></table></div>
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">docId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Document ID within the store. If provided, existing configuration from the document will be used for the new document</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">metadata</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Metadata associated with the document</div>
<div class="api-property-example">Example: <code>{"foo":"bar"}</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">replaceExisting</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether to replace existing document loader with the new upserted chunks. However this does not delete the existing embeddings in the vector store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createNewDocStore</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether to create a new document store</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">docStore</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Only when createNewDocStore is true, pass in the new document store configuration</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the new document store to be created</div>
<div class="api-property-example">Example: <code>"plainText"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Description of the new document store to be created</div>
<div class="api-property-example">Example: <code>"plainText"</code></div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">loader</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the loader (camelCase)</div>
<div class="api-property-example">Example: <code>"plainText"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">config</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the loader</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">splitter</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the text splitter (camelCase)</div>
<div class="api-property-example">Example: <code>"recursiveCharacterTextSplitter"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">config</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the text splitter</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">embedding</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the embedding generator (camelCase)</div>
<div class="api-property-example">Example: <code>"openAIEmbeddings"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">config</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the embedding generator</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">vectorStore</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the vector store (camelCase)</div>
<div class="api-property-example">Example: <code>"faiss"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">config</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the vector store</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">recordManager</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the record manager (camelCase)</div>
<div class="api-property-example">Example: <code>"postgresRecordManager"</code></div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">config</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the record manager</div>
</div>
</div></div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully execute upsert operation</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">numAdded</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of vectors added</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">numDeleted</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of vectors deleted</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">numUpdated</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of vectors updated</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">numSkipped</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of vectors skipped (not added, deleted, or updated)</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">addedDocs</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid request body</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
POST
/document-store/refresh/{id}
Re-process and upsert all documents in document store
Re-process and upsert all existing documents in document store
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr></tbody></table></div>
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">items</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully execute refresh operation</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid request body</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
POST
/document-store/vectorstore/query
Retrieval query
Retrieval query for the upserted chunks
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">storeId</span>
<span class="api-property-type">string</span>
<span class="api-property-required">required</span>
</div>
<div class="api-property-desc">Document store ID</div>
<div class="api-property-example">Example: <code>"603a7b51-ae7c-4b0a-8865-e454ed2f6766"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">query</span>
<span class="api-property-type">string</span>
<span class="api-property-required">required</span>
</div>
<div class="api-property-desc">Query to search for</div>
<div class="api-property-example">Example: <code>"What is the capital of France?"</code></div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully executed query on vector store</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">timeTaken</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Time taken to execute the query (in milliseconds)</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">docs</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid request body</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
DELETE
/document-store/loader/{storeId}/{loaderId}
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.
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>storeId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr><tr><td><strong>loaderId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Loader ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully deleted loader from document store</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid ID provided</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document Store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
DELETE
/document-store/vectorstore/{id}
Delete data from vector store
Only data that were upserted with Record Manager will be deleted from vector store
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully deleted data from vector store</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid ID provided</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document Store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
GET
/document-store/chunks/{storeId}/{loaderId}/{pageNo}
Get chunks from a specific document loader
Get chunks from a specific document loader within a document store
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>storeId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr><tr><td><strong>loaderId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document loader ID</td></tr><tr><td><strong>pageNo</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Pagination number</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully retrieved chunks from document loader</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chunks</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">count</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">file</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderConfig</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterConfig</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">totalChunks</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Total number of chunks</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">totalChars</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Total number of characters</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">storeId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">files</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">source</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Source of the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">credential</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Credential associated with the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">rehydrated</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether the loader has been rehydrated</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">preview</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether the loader is in preview mode</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">previewChunkCount</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of chunks in preview mode</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">currentPage</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">storeName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
PUT
/document-store/chunks/{storeId}/{loaderId}/{chunkId}
Update a specific chunk
Updates a specific chunk from a document loader
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>storeId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr><tr><td><strong>loaderId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Loader ID</td></tr><tr><td><strong>chunkId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Chunk ID</td></tr></tbody></table></div>
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">pageContent</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-example">Example: <code>"This is the content of the page."</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">metadata</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-example">Example: <code>{"author":"John Doe","date":"2024-08-24"}</code></div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully updated chunk</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chunks</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">count</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-example">Example: <code>1</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">file</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">loaderConfig</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">splitterConfig</span>
<span class="api-property-type">object</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Configuration for the text splitter</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">totalChunks</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Total number of chunks</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">totalChars</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Total number of characters</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">status</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Status of the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">storeId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the document store</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">files</span>
<span class="api-property-type">array</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">source</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Source of the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">credential</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Credential associated with the document store loader</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">rehydrated</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether the loader has been rehydrated</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">preview</span>
<span class="api-property-type">boolean</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Whether the loader is in preview mode</div>
</div>
<div class="api-property-row" style="margin-left: 12px;">
<div class="api-property-meta">
<span class="api-property-name">previewChunkCount</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Number of chunks in preview mode</div>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">currentPage</span>
<span class="api-property-type">number</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">storeName</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">description</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
DELETE
/document-store/chunks/{storeId}/{loaderId}/{chunkId}
Delete a specific chunk from a document loader
Delete a specific chunk from a document loader
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>storeId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Store ID</td></tr><tr><td><strong>loaderId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Loader ID</td></tr><tr><td><strong>chunkId</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Document Chunk ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successfully deleted chunk</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid ID provided</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Document Store not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>