FruxonDocs
ApiKnowledge bases

Creates a knowledge base and its backing inline asset.

Creates the editable corpus and provisions the inline backing asset that agents attach to. The knowledge base is attachable immediately, but it becomes searchable only after documents are added and the knowledge base is published.

POST
/v1/tenants/{tenant}/knowledgeBases

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Request Body

Knowledge base name, optional description, locale, and embedding configuration.

displayName?string
description?string|null
locale?string|null
networkId?string|null

The Application that owns this corpus. Omit for a tenant-wide base — appropriate for hand-authored knowledge, and refused for conversation-derived sources, which may not widen their audience.

Formatuuid
autoPublish?boolean

Publish automatically whenever a document changes. Defaults to off.

consolidatorAgentId?string|null

Agent that decides and writes each merge in a consolidation pass. Omit for report-only passes.

consolidationPolicy?

Per-base defaults for consolidation passes. Omitted members use the platform defaults.

embedding*

Embedding model + chunking (and inline API key, unless CreateKnowledgeBaseRequest.EmbeddingLLMConfigId is set) for the backing inline asset. Mirrors ordinary asset creation.

embeddingLLMConfigId?string|null

Optional tenant LLM config supplying the embedding API key instead of an inline key.

Formatuuid
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases" \  -H "Content-Type: application/json" \  -d '{    "embedding": {      "provider": "string",      "model": "string"    }  }'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "displayName": "string",
  "description": "string",
  "locale": "string",
  "suggestedLocale": {
    "locale": "string",
    "matching": 0,
    "considered": 0,
    "detected": false
  },
  "networkId": "00000000-0000-0000-0000-000000000000",
  "autoPublish": false,
  "automaticPublishWithheld": false,
  "consolidatorAgentId": "string",
  "correctionsAvailable": false,
  "consolidationPolicy": {
    "version": 0,
    "cadence": "MANUAL",
    "mode": "REPORT_ONLY",
    "similarityThreshold": 0,
    "maxClusterSize": 0,
    "recentWriteWindowMinutes": 0,
    "autoAskDailyLimit": 0,
    "calibration": {
      "runId": "00000000-0000-0000-0000-000000000000",
      "similarityThreshold": 0,
      "embeddingModel": "string",
      "locale": "string",
      "calibratedBy": "string",
      "calibratedAt": 0
    }
  },
  "consolidationRecipe": {
    "domain": "string",
    "locale": "string",
    "categories": [
      "string"
    ],
    "provider": {
      "providerId": "string",
      "model": "string",
      "parameters": {},
      "fallbacks": [],
      "builtInTools": [],
      "tenantConfigId": "00000000-0000-0000-0000-000000000000"
    },
    "recipeVersion": 0,
    "upgradeAvailable": {
      "from": 0,
      "to": 0,
      "kind": "AGENTS_ONLY"
    }
  },
  "lastConsolidatedAt": 0,
  "backingAssetId": "string",
  "embedding": {
    "provider": "string",
    "model": "string",
    "chunkSize": 0,
    "chunkOverlap": 0
  },
  "status": "ACTIVE",
  "lastPublishedAt": 0,
  "contentRevision": 0,
  "publishedContentRevision": 0,
  "changesPending": false,
  "publishPendingSince": 0,
  "publishState": "NONE",
  "lastPublishError": "string",
  "lastPublishErrorCategory": "CREDENTIALS",
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty