Obter bases de conhecimento

Obter todas as bases de conhecimento para o usuário autenticado

GET https://suasofia.online/api//user/knowledgebases

Obter bases de conhecimento

cURL

curl --request GET \
  --url https://suasofia.online/api/user/knowledgebases \
  --header 'Authorization: Bearer <token>'

200 Response

{
  "data": [
    {
      "id": 1,
      "name": "Documentação do Produto",
      "description": "Documentação técnica para nossos produtos",
      "status": "active",
      "status_label": "Ativo",
      "documents_count": 5,
      "assistants_count": 2,
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-08T14:20:00.000000Z"
    },
    {
      "id": 2,
      "name": "Conhecimento de FAQ",
      "description": "Perguntas frequentes e respostas",
      "status": "processing",
      "status_label": "Processando",
      "documents_count": 1,
      "assistants_count": 0,
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:05:00.000000Z"
    }
  ]
}

Este endpoint retorna uma lista de todas as bases de conhecimento associadas à sua conta. As bases de conhecimento são usadas para armazenar documentos que fornecem contexto e informações para seus assistentes de IA.

Resposta

data · array

Array de objetos base de conhecimento

Show propriedades da base de conhecimento

id · integer

O identificador único da base de conhecimento

name · string

O nome da base de conhecimento

description · string

Descrição opcional da base de conhecimento

status · string

Status atual: empty, processing, active, ou failed

status_label · string

Rótulo de status legível

documents_count · integer

Número de documentos nesta base de conhecimento

assistants_count · integer

Número de assistentes usando esta base de conhecimento

created_at · string

Timestamp ISO 8601 da criação

updated_at · string

Timestamp ISO 8601 da última atualização

200 Response

{
  "data": [
    {
      "id": 1,
      "name": "Documentação do Produto",
      "description": "Documentação técnica para nossos produtos",
      "status": "active",
      "status_label": "Ativo",
      "documents_count": 5,
      "assistants_count": 2,
      "created_at": "2025-01-05T10:30:00.000000Z",
      "updated_at": "2025-01-08T14:20:00.000000Z"
    },
    {
      "id": 2,
      "name": "Conhecimento de FAQ",
      "description": "Perguntas frequentes e respostas",
      "status": "processing",
      "status_label": "Processando",
      "documents_count": 1,
      "assistants_count": 0,
      "created_at": "2025-01-08T09:00:00.000000Z",
      "updated_at": "2025-01-08T09:05:00.000000Z"
    }
  ]
}

Status das Bases de Conhecimento

Status	Descrição
empty	Base de conhecimento não possui documentos
processing	Um ou mais documentos estão sendo processados
active	Todos os documentos foram processados e estão prontos
failed	Um ou mais documentos falharam ao processar