Load Vectorstore Api

Load an additional document into an existing vectorstore. Analogous to the endpoint /vectorstores/add-documents for a single document.

Args: vectorstore_id (Optional[str], optional): The ID of the vectorstore. Defaults to Form(None). vectorstore_name (Optional[str], optional): The name of the vectorstore. Defaults to Form(None). document (str | UploadFile | list[str | UploadFile], optional): The document to load into the vectorstore. Defaults to Form(...). document_name (Optional[str], optional): The name of the document. Defaults to Form(None). document_type (Optional[str], optional): The type of the document. Defaults to Form('File'). chunk_size (Optional[int], optional): The size of each chunk. Defaults to Form(None). chunk_overlap (Optional[int], optional): The overlap between chunks. Defaults to Form(None). selected_items (str, optional): The selected items. Defaults to Form(None). select_all_items_flags (str, optional): The flag to select all items. Defaults to Form(None). metadata (Optional[str], optional): The metadata of the document. Defaults to Form(None). metadata_by_item (Optional[str], optional): The metadata by item. Defaults to Form(None). api_key (str, optional): The API key. Defaults to Depends(validate_api_key).

Raises: VSError: If an error occurs, can be a rate limit error

Returns: dict: The result of the operation.

post/api/vectorstores/load

Request

  • Base URL: https://api.vectorshift.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.vectorshift.ai/api/vectorstores/load
  • Auth: one of:
    • API key in header Private-Key
    • API key in query parameter Private-Key
    • API key in header Private-Key
    • API key in header Private-Key
    • API key in query parameter Private-Key
    • API key in query parameter Private-Key

Query parameters

allow_mcp_keysboolean

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.