Vector Indexing API

The Vector Indexing API allows you to manage vector embeddings for your documents, retrieve statistics, and perform vector operations.

Get Vector Indexing Stats

Get statistics about the indexed data.

GET /api/vector-indexing/stats

Response

Returns statistics about the indexed data, including document and chunk counts, embedding dimensions, and storage usage.

Get Indexed Documents

Get list of indexed documents with their metadata.

GET /api/vector-indexing/documents

Response

Returns a list of indexed documents with metadata such as file name, size, creation date, and indexing status.

Get Sample Chunks

Get sample chunks with their vector embeddings.

GET /api/vector-indexing/chunks

Query Parameters

ParameterTypeDescriptionDefault
limitintegerMaximum number of chunks to return5

Response

Returns sample chunks with their vector embeddings.

Get File Embeddings

Get embeddings for a specific file.

GET /api/vector-indexing/embeddings/{file_id}

Path Parameters

ParameterTypeDescription
file_idstringID of the file to retrieve embeddings for

Response

Returns the vector embeddings for the specified file.

Generate Local Vectors

Generate vectors locally using a simple embedding algorithm.

POST /api/vector-indexing/generate-local-vectors

Response

Returns a status object with information about the local vector generation process.

Get Local Indexing Status

Get the current status of local vector indexing.

GET /api/vector-indexing/local-indexing-status

Response

Returns the current status of the local vector indexing process.

Download Document

Download a document by its ID.

GET /api/vector-indexing/documents/{document_id}/download

Path Parameters

ParameterTypeDescription
document_idstringID of the document to download

Response

Returns the document content for download.