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

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 Autenticação
Requer cabeçalho authorization: <seu_token>.

​
Cabeçalhos

authorization: <seu_token>

​
Exemplo (cURL)

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

​
Respostas

​
Response - Success

response
{
  "status": "OK",
  "data": [
    {
      "id": "KB_123456",
      "name": "Base A",
      "description": "Descrição da base",
      "enabled": true,
      "sectors": ["hr"],
      "content": "https://storage.orkeia.ai/kb/base-a.pdf",
      "type": "file",
      "multimodal": false,
      "tags": ["tag1","tag2"]
    }
  ]
}

​
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.