Pular para o conteúdo principal
POST
/
knowledge-bases
Endpoint
POST https://gateway.orkeia.ai/knowledge-bases
Autenticação
Requer cabeçalho authorization: <seu_token>.

Request body

O serviço espera um wrapper com knowledgeBase e filename.
{
  "knowledgeBase": {
    "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"]
  },
  "filename": "policies.pdf"
}
Notas
  • Para type: "file", envie filename correspondente ao conteúdo armazenado.
  • Para type: "url" ou type: "text", filename pode ser ignorado/ficar vazio, mas o campo existe no payload por consistência do endpoint.
  • content:
    • file: caminho/URL de armazenamento do arquivo (ex.: S3/Storage).
    • url: link público/privado a ser referenciado.
    • text: conteúdo textual direto.

Exemplo (cURL)

curl -X POST "https://gateway.orkeia.ai/knowledge-bases"   -H "Authorization: Bearer <seu_token>"   -H "Content-Type: application/json"   -d '{
    "knowledgeBase": {
      "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"]
    },
    "filename": "policies.pdf",
  }'
###Interface de referência:
export interface KnowledgeBase {
  id?: string;
  name: string;
  description: string;
  enabled: boolean;
  sectors: string[];
  content: string;
  type: 'file' | 'url' | 'text';
  multimodal: boolean;
  tags: string[];
}
NomeTipoObrigatórioDescriçãoExemplo
idstringNãoIdentificador único da base de conhecimento (retornado pelo backend).”KB_123456”
namestringSimNome da base de conhecimento.”Políticas Internas”
descriptionstringSimDescrição breve do conteúdo/uso.”Documentos corporativos oficiais”
enabledbooleanSimIndica se a base estará ativa no ambiente.true
sectorsstring[]SimSetores que podem consumir essa base (governança de acesso).[“hr”, “legal”]
contentstringSimFonte do conteúdo: caminho/URL do arquivo, link externo, ou texto literal (conforme type).https://storage.orkeia.ai/kb/policies.pdf
type”file” | “url” | “text”SimTipo do conteúdo.”file”
multimodalbooleanSimSe a base contém modalidades além de texto (imagens/áudio/vídeo).false
tagsstring[]SimMetadados/etiquetas para busca e organização.[“compliance”,“contracts”]

Respostas

Response - Success

response
{
  "status": "OK",
  "data": { "id": "KB_123456" }
}

500 — Bad Request

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

400 — Client Error

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