FruxonDocs
ApiKnowledge bases

Shows what a change to a source would rebuild, changing nothing.

Takes the same body as the source PATCH and runs the same validation, then answers with the plan: each agent or automation that would get a new revision, a new schedule or a new name, the request fields that make it necessary, and anything worth reading first — a change applies only to items processed from then on, a language change on a source that has already read conversations leaves a mixed-language corpus, a removed topic stays on the articles already filed under it. The mapping from a setting to the resources it feeds lives here, so a client never has to know it.

POST
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/sources/{source}:previewUpdate

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
source*string

The knowledge source id.

Formatuuid
tenant*string

The tenant identifier

Request Body

The change to preview, exactly as it would be sent to PATCH.

approvalPolicy?string
Value in"UNSPECIFIED" | "MANUAL" | "SAMPLED" | "AUTOMATIC"
approvalSamplePercent?integer|null

Percentage of otherwise eligible Sampled outputs that stay in Draft for quality review. Risk-flagged, low-confidence and rewrite outputs always stay in Draft regardless of this value.

Formatint32
Range0 <= value <= 100
publishPolicy?string
Value in"UNSPECIFIED" | "MANUAL" | "AUTOMATIC_AFTER_APPROVAL"
displayName?string|null

Renames the source. On a managed source the agents and automation it built are renamed with it; on a linked one only the source record is, because Knowledge does not change an implementation it does not own.

conversations?

Managed conversation sources only: the recipe settings to change. Only the resources that read a changed setting are rebuilt, each as a new deployed revision. What decides which conversations the source reads (door, account, filters, start date) is not changeable here — that is a new source.

rebuildBaseAgents?boolean|null

Rebuild the knowledge base's consolidator and editor from this source's settings even though none of their inputs changed — for a pair handed over from a deleted source. Valid only when this source provides them.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08:previewUpdate" \  -H "Content-Type: application/json" \  -d '{}'
{
  "changes": [
    {
      "resourceKind": "TRIGGER",
      "role": "SOURCE",
      "resourceId": "string",
      "because": [
        "string"
      ],
      "rebuilds": false,
      "note": "BUILT_FROM_ANOTHER_SOURCE"
    }
  ],
  "warnings": [
    "APPLIES_TO_NEW_ITEMS_ONLY"
  ],
  "recipeUpgrade": {
    "from": 0,
    "to": 0
  },
  "isEmpty": false
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}