Obtener una lista de documentos en un Almacén de Vectores

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
chevron-right
200

A list of documents.

application/json
idintegerOptional

Document ID.

namestringOptional

Document name.

typestringOptional

Document type.

vector_storestringOptional

The ID of the vector store.

sizeintegerOptional

Document size in bytes.

statusstringOptional

Document status.

processing_statusstringOptional

Processing status.

indexed_onstring · date-time · nullableOptional

Time when the document was indexed.

status_error_messagestring · nullableOptional

Error message for status.

createdstring · date-timeOptional

Creation timestamp.

modifiedstring · date-timeOptional

Modification timestamp.

get
/vector-stores/{vector-store-id}/documents
200

A list of documents.

Ejemplos de Solicitudes

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

Reemplaza TU_API_KEY con tu clave API real de Vector Store y vs_abc123 con tu ID de Vector Store.

Parámetros de Ruta

Parámetro
Tipo
Descripción

vector-store-id

string

Requerido. El ID de la tienda de vectores de la que listar documentos.

Formato de Respuesta

Autenticación

Este endpoint requiere autenticación utilizando una clave API en el encabezado x-api-key.

Respuestas de Error

Código de Estado
Descripción

401

No autorizado - Clave API inválida o faltante

404

No encontrado - Almacén de vectores no encontrado

500

Error interno del servidor

Este endpoint recupera una lista de todos los documentos almacenados en el almacén de vectores especificado. Proporciona metadatos sobre cada documento, incluyendo el estado de procesamiento del documento, tamaño y marca de tiempo indexada. Esta información es útil para monitorear el contenido de su almacén de vectores y verificar el estado de procesamiento de los documentos.

Last updated