Obter documento

Obter um único documento por ID

GET https://suasofia.online/api//user/knowledgebases/{knowledgebaseId}/documents/{documentId}

Obter documento

cURL

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

200 Response

{
  "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"
  }
}

Este endpoint retorna os detalhes de um documento específico dentro de uma base de conhecimento.

Parâmetros de Rota

knowledgebaseId · integer · required

O identificador único da base de conhecimento

documentId · integer · required

O identificador único do documento

Resposta

data · object

O objeto documento

Show propriedades do documento

id · integer

O identificador único do documento

name · string

O nome do documento

description · string

Descrição opcional do documento

type · string

Tipo do documento: website, pdf, txt, ou docx

type_label · string

Rótulo de tipo legível

status · string

Status de processamento: processing, active, ou failed

status_label · string

Rótulo de status legível

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": "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"
  }
}