Pular para o conteúdo principal
GET
/
knowledge-bases
/
:id
Detalhar Base de Conhecimento
curl --request GET \
  --url https://api.example.com/knowledge-bases/:id

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://gateway.orkeia.ai/knowledge-bases/{id} Autenticação
Requer cabeçalho authorization: <seu_token>.

​
Parâmetros de Caminho

NomeTipoObrigatórioDescriçãoExemplo
idstringSimIdentificador da base de conhecimento.KB_123456

​
Exemplo (cURL)

curl -X GET "https://gateway.orkeia.ai/knowledge-bases/KB_123456" \
  -H "authorization:  <seu_token>"

​
Respostas

​
Response - Success

response
{
  "status": "OK",
  "data": {
    "id": "KB_123456",
    "name": "Políticas Internas",
    "description": "Documentos corporativos oficiais",
    "enabled": true,
    "sectors": ["hr", "legal"],
    "content": "https://storage.orkeia.ai/kb/policies.pdf",
    "type": "file",
    "multimodal": false,
    "tags": ["compliance", "contracts"]
  }
}

​
500 — Server Error

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}

​
Campos

NomeTipoDescrição
idstringIdentificador único da base de conhecimento.
namestringNome da base de conhecimento.
descriptionstringDescrição breve do conteúdo/uso.
enabledbooleanIndica se a base está ativa no ambiente.
sectorsstring[]Setores que podem consumir essa base (governança de acesso).
contentstringFonte do conteúdo: caminho/URL do arquivo, link externo, ou texto literal (conforme type).
type”file” | “url” | “text”Tipo do conteúdo.
multimodalbooleanSe a base contém modalidades além de texto (imagens/áudio/vídeo).
tagsstring[]Metadados/etiquetas para busca e organização.