NOnoxus
V1 - Knowledge Bases

Public Import Kb

Import a knowledge base from an export file.

The definition should be the base64-encoded content from a previous export. Returns the created knowledge base with its new ID.

post/v1/knowledge-bases/import

Request

  • Base URL
    https://api.app.noxus.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-Key

Query parameters

mode'version' | 'clone' | 'replace'

Operator control over how a bundle's artifacts land in the target.

  • version: keep the bundle's IDs. If the artifact already exists in the target workspace, append a new version row (Workflow/Assistant) or refuse with NOT_VERSIONABLE (KB/Inbox — use replace). If not, create with the bundle's id. Lineage history is appended on every successful artifact write.
  • clone: today's default — fresh UUIDs everywhere, no history.
  • replace: keep IDs, overwrite the active definition in place. No version row. Lineage history is appended.
activateboolean
on_missing_dependency'fail' | 'warn'
dry_runboolean

Request body

definitionstring required
version'auto' | 'v3' | 'v4'

Wire format for an export/import payload.

  • auto (default both directions): export emits the default format (currently v3 base64, for back-compat with existing pipelines); import detects the format from the payload content.
  • v4: plaintext multi-doc YAML (.nx) — opt-in, requested on purpose.
  • v3: legacy base64-encoded bundle.

Response

Successful Response

referencestring required
type'kb' | 'workflow' | 'assistant' | 'file' | 'inbox' | 'connection' | 'secret' | 'deployment' | 'table' | 'trigger' required
versionstring nullable
namestring nullable
iconstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.