Get a list of documents in a Vector Store

get

List all documents in a vector store.

Path parameters

vector-store-idstringRequired

The ID of the vector store.

Header parameters

x-api-keystringRequired

The API key for authentication.

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/vector-stores/{vector-store-id}/documents HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Accept: */*

200

A list of documents.

[
  {
    "id": 1,
    "name": "text",
    "type": "text",
    "vector_store": "text",
    "size": 1,
    "status": "text",
    "processing_status": "text",
    "indexed_on": "2025-04-26T08:58:58.037Z",
    "status_error_message": "text",
    "created": "2025-04-26T08:58:58.037Z",
    "modified": "2025-04-26T08:58:58.037Z"
  }
]

Example Requests

cURL

curl -X GET \
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents \
  -H "x-api-key: YOUR_API_KEY"

Replace YOUR_API_KEY with your actual Vector Store API key and vs_abc123 with your Vector Store ID.

JavaScript

const getVectorStoreDocuments = async (vectorStoreId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents`, {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });
  
  const data = await response.json();
  console.log(data);
};

getVectorStoreDocuments('vs_abc123');

Replace YOUR_API_KEY with your actual Vector Store API key and vs_abc123 with your Vector Store ID.

Python

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }
    
    response = requests.get(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents",
        headers=headers
    )
    
    data = response.json()
    print(data)

get_vector_store_documents('vs_abc123')

Replace YOUR_API_KEY with your actual Vector Store API key and vs_abc123 with your Vector Store ID.

Path Parameters

Parameter	Type	Description
vector-store-id	string	Required. The ID of the vector store to list documents from.

Response Format

[
  {
    "id": 1234,
    "name": "Product Manual.pdf",
    "type": "application/pdf",
    "vector_store": "vs_abc123",
    "size": 250000,
    "status": "indexed",
    "processing_status": "completed",
    "indexed_on": "2023-06-15T10:30:00Z",
    "status_error_message": null,
    "created": "2023-06-15T10:15:00Z",
    "modified": "2023-06-15T10:30:00Z"
  },
  {
    "id": 1235,
    "name": "Technical Specifications.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "indexed",
    "processing_status": "completed",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

Authentication

This endpoint requires authentication using an API key in the x-api-key header.

Error Responses

Status Code	Description
401	Unauthorized - Invalid or missing API key
404	Not Found - Vector Store not found
500	Internal Server Error

This endpoint retrieves a list of all documents stored in the specified vector store. It provides metadata about each document, including the document's processing status, size, and indexed timestamp. This information is useful for monitoring your vector store's contents and checking document processing status.