Skip to content

Get the information of a document

GET /vector-stores/{vector-store-id}/documents/{document-id}

Retrieve the information of a document in a Vector Store.

Parameter In Type Required Description
vector-store-id path string yes The ID of the vector store.
document-id path integer yes The ID of the document.
x-api-key header string yes The API key for authentication.

Responses

  • 200 — Document details retrieved successfully.

Example Requests

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

Info

Replace YOUR_API_KEY with your actual Vector Store API key, vs_abc123 with your Vector Store ID, and 1234 with the document ID.

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

  const data = await response.json();
  console.log(data);
};

getDocumentInfo('vs_abc123', 1234);

Info

Replace YOUR_API_KEY with your actual Vector Store API key, vs_abc123 with your Vector Store ID, and 1234 with the document ID.

import requests

def get_document_info(vector_store_id, document_id):
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }

    response = requests.get(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/{document_id}",
        headers=headers
    )

    data = response.json()
    print(data)

get_document_info('vs_abc123', 1234)

Info

Replace YOUR_API_KEY with your actual Vector Store API key, vs_abc123 with your Vector Store ID, and 1234 with the document ID.

Path Parameters

Parameter Type Description
vector-store-id string Required. The ID of the vector store containing the document.
document-id integer Required. The ID of the document to retrieve.

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"
}

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 or document not found
500 Internal Server Error

This endpoint retrieves detailed information about a specific document in the vector store. It's useful for checking the processing status of individual documents and retrieving metadata like file type, size, and timestamps. This can be particularly helpful when troubleshooting issues with document processing or when you need to verify that a document was properly indexed.