Obter base de conhecimento

Obter uma única base de conhecimento por ID

GET https://suasofia.online/api//user/knowledgebases/{id}

Obter base de conhecimento

cURL

curl --request GET \
  --url https://suasofia.online/api/user/knowledgebases/{id} \
  --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"
  }
}

Este endpoint retorna os detalhes de uma base de conhecimento específica.

Parâmetros de Rota

id · integer · required

O identificador único da base de conhecimento

Resposta

data · object

O objeto 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"
  }
}