Skip to main content
GET
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
Obter documentos
curl --request GET \
  --url https://suasofia.online/api/user/knowledgebases/{knowledgebaseId}/documents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "name": "Manual do Produto",
      "description": "Manual completo do usuário do produto",
      "type": "pdf",
      "type_label": "PDF",
      "status": "active",
      "status_label": "Ativo",
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-05T10:35:00.000000Z"
    },
    {
      "id": 2,
      "name": "Website da Empresa",
      "description": "Conteúdo principal do website",
      "type": "website",
      "type_label": "Website",
      "status": "processing",
      "status_label": "Processando",
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:00:00.000000Z"
    }
  ]
}
Este endpoint retorna uma lista de todos os documentos em uma base de conhecimento específica.

​
Parâmetros de Rota

​
knowledgebaseId
integer
required
O identificador único da base de conhecimento

​
Resposta

​
data
array
Array de objetos documento
{
  "data": [
    {
      "id": 1,
      "name": "Manual do Produto",
      "description": "Manual completo do usuário do produto",
      "type": "pdf",
      "type_label": "PDF",
      "status": "active",
      "status_label": "Ativo",
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-05T10:35:00.000000Z"
    },
    {
      "id": 2,
      "name": "Website da Empresa",
      "description": "Conteúdo principal do website",
      "type": "website",
      "type_label": "Website",
      "status": "processing",
      "status_label": "Processando",
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:00:00.000000Z"
    }
  ]
}

​
Status dos Documentos

StatusDescrição
processingDocumento está sendo analisado e incorporado no banco de dados de vetores
activeDocumento foi processado e está pronto para uso
failedProcessamento do documento falhou