> ## Documentation Index
> Fetch the complete documentation index at: https://docs.suasofia.online/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter documentos

> Obter todos os documentos de uma base de conhecimento

Este endpoint retorna uma lista de todos os documentos em uma base de conhecimento específica.

### Parâmetros de Rota

<ParamField path="knowledgebaseId" type="integer" required>
  O identificador único da base de conhecimento
</ParamField>

### Resposta

<ResponseField name="data" type="array">
  Array de objetos documento

  <Expandable title="propriedades do documento">
    <ResponseField name="id" type="integer">
      O identificador único do documento
    </ResponseField>

    <ResponseField name="name" type="string">
      O nome do documento
    </ResponseField>

    <ResponseField name="description" type="string">
      Descrição opcional do documento
    </ResponseField>

    <ResponseField name="type" type="string">
      Tipo do documento: `website`, `pdf`, `txt`, ou `docx`
    </ResponseField>

    <ResponseField name="type_label" type="string">
      Rótulo de tipo legível
    </ResponseField>

    <ResponseField name="status" type="string">
      Status de processamento: `processing`, `active`, ou `failed`
    </ResponseField>

    <ResponseField name="status_label" type="string">
      Rótulo de status legível
    </ResponseField>

    <ResponseField name="created_at" type="string">
      Timestamp ISO 8601 da criação
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      Timestamp ISO 8601 da última atualização
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "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"
      }
    ]
  }
  ```

  ```json 404 Knowledgebase Not Found theme={null}
  {
    "error": "Base de conhecimento não encontrada."
  }
  ```
</ResponseExample>

### Status dos Documentos

| Status       | Descrição                                                                 |
| ------------ | ------------------------------------------------------------------------- |
| `processing` | Documento está sendo analisado e incorporado no banco de dados de vetores |
| `active`     | Documento foi processado e está pronto para uso                           |
| `failed`     | Processamento do documento falhou                                         |
