Obter as informações de um documento

get

Retrieve the information of a document in a Vector Store.

Path parameters

vector-store-idstringRequired

The ID of the vector store.

document-idintegerRequired

The ID of the document.

Header parameters

x-api-keystringRequired

The API key for authentication.

Responses

200

Document details retrieved successfully.

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/{document-id}

HTTPcURLJavaScriptPython

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

200

Document details retrieved successfully.

{
  "id": 1,
  "name": "text",
  "type": "text",
  "vector_store": "text",
  "size": 1,
  "status": "text",
  "processing_status": "text",
  "indexed_on": "2026-03-30T17:31:51.438Z",
  "status_error_message": "text",
  "created": "2026-03-30T17:31:51.438Z",
  "modified": "2026-03-30T17:31:51.438Z"
}

Exemplos de Requisições

cURL

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

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store, vs_abc123 pelo seu ID do Vector Store e 1234 pelo ID do documento.

JavaScript

Python

Parâmetros de Caminho

Parâmetro	Tipo	Descrição
vector-store-id	string	Obrigatório. O ID do armazenamento de vetores contendo o documento.
document-id	integer	Obrigatório. O ID do documento a ser recuperado.

Formato de Resposta

{
  "id": 1234,
  "name": "Manual do Produto.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "indexado",
  "processing_status": "concluído",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30:00Z"
}

Autenticação

Este endpoint requer autenticação usando uma chave de API no cabeçalho x-api-key.

Respostas de Erro

Código de Status	Descrição
401	Não Autorizado - Chave de API inválida ou ausente
404	Não Encontrado - Armazenamento de Vetores ou documento não encontrado
500	Erro Interno do Servidor

Este endpoint recupera informações detalhadas sobre um documento específico no armazenamento de vetores. É útil para verificar o status de processamento de documentos individuais e recuperar metadados como tipo de arquivo, tamanho e timestamps. Isso pode ser particularmente útil ao solucionar problemas com o processamento de documentos ou quando você precisa verificar se um documento foi indexado corretamente.