Saltar al contenido principal
POST
/
knowledge-bases
Endpoint
POST https://gateway.orkeia.ai/knowledge-bases
Autenticación
Requiere el encabezado authorization: <tu_token>.

Cuerpo de la solicitud

El servicio espera un wrapper con knowledgeBase y filename.
{
  "knowledgeBase": {
    "name": "Políticas Internas",
    "description": "Documentos corporativos oficiales",
    "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", envíe filename correspondiente al contenido almacenado.
  • Para type: "url" o type: "text", filename puede ser ignorado/vacío, pero el campo existe en el payload por consistencia del endpoint.
  • content:
    • file: ruta/URL de almacenamiento del archivo (ej.: S3/Storage).
    • url: enlace público/privado a ser referenciado.
    • text: contenido textual directo.

Ejemplo (cURL)

curl -X POST "https://gateway.orkeia.ai/knowledge-bases"   -H "Authorization: Bearer <tu_token>"   -H "Content-Type: application/json"   -d '{
    "knowledgeBase": {
      "name": "Políticas Internas",
      "description": "Documentos corporativos oficiales",
      "enabled": true,
      "sectors": ["hr", "legal"],
      "content": "https://storage.orkeia.ai/kb/policies.pdf",
      "type": "file",
      "multimodal": false,
      "tags": ["compliance", "contracts"]
    },
    "filename": "policies.pdf",
  }'

Interfaz de referencia:

export interface KnowledgeBase {
  id?: string;
  name: string;
  description: string;
  enabled: boolean;
  sectors: string[];
  content: string;
  type: 'file' | 'url' | 'text';
  multimodal: boolean;
  tags: string[];
}
NombreTipoObligatorioDescripciónEjemplo
idstringNoIdentificador único de la base de conocimiento (retornado por el backend).”KB_123456”
namestringNombre de la base de conocimiento.”Políticas Internas”
descriptionstringDescripción breve del contenido/uso.”Documentos corporativos oficiales”
enabledbooleanIndica si la base estará activa en el ambiente.true
sectorsstring[]Sectores que pueden consumir esta base (gobernanza de acceso).[“hr”, “legal”]
contentstringFuente del contenido: ruta/URL del archivo, enlace externo, o texto literal (conforme type).https://storage.orkeia.ai/kb/policies.pdf
type”file” | “url” | “text”Tipo del contenido.”file”
multimodalbooleanSi la base contiene modalidades además de texto (imágenes/audio/vídeo).false
tagsstring[]Metadatos/etiquetas para búsqueda y organización.[“compliance”,“contracts”]

Respuestas

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
}