FruxonDocs
ApiKnowledge bases

Changes a source's policy, its name, or the settings it was built with.

Omitted properties stay unchanged. Approval, quality-sample and snapshot-publish policy apply to any source. A managed conversation source can also change the recipe settings it was created with — product, language, topics, what a conversation is called, bot lines, models and schedule — and only the resources that read a changed setting are rebuilt, each as a new deployed revision of the same agent or a revalidated edit of the same automation, so history and backlog are kept. What decides which conversations a source reads (door, account, filters, start date) is not changeable: that is a new source. A change applies to items processed from then on; nothing already processed is run again. `:previewUpdate` takes the same body and answers which resources it would change and why, without changing anything. Resources are rebuilt before the source record is updated, so a failed rebuild never records settings the implementation does not run, and repeating the request converges. Automatic approval still requires a current successful consolidation calibration. A change already being applied to the same source answers 409.

PATCH
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/sources/{source}
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

The properties to change.

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 PATCH "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "knowledgeBaseId": "619a59ff-6d34-4e0c-9a58-4d2cf062eac9",
  "displayName": "string",
  "kind": "UNSPECIFIED",
  "status": "UNSPECIFIED",
  "managementMode": "UNSPECIFIED",
  "recipeKey": "string",
  "recipeVersion": 0,
  "config": null,
  "approvalPolicy": "UNSPECIFIED",
  "approvalSamplePercent": 0,
  "publishPolicy": "UNSPECIFIED",
  "settingsEditable": true,
  "settingsNotEditableReason": "string",
  "upgradeAvailable": {
    "from": 0,
    "to": 0,
    "kind": "UNSPECIFIED"
  },
  "openUpgrade": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ownerKind": "UNSPECIFIED",
    "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
    "recipeKey": "string",
    "fromVersion": 0,
    "toVersion": 0,
    "status": "UNSPECIFIED",
    "failedDuring": "UNSPECIFIED",
    "detail": "string",
    "wasActive": true,
    "canRollBack": true,
    "work": {
      "agents": [
        {
          "role": "UNSPECIFIED",
          "agentId": "string",
          "action": "UNSPECIFIED",
          "targetHash": "string"
        }
      ],
      "automation": {
        "triggerId": "b89c9c0a-30c6-475a-b185-93813e22ffcf",
        "action": "UNSPECIFIED",
        "targetHash": "string"
      },
      "drainStageIds": [
        "string"
      ]
    },
    "revisionsBefore": {
      "property1": 0,
      "property2": 0
    },
    "revisionsAfter": {
      "property1": 0,
      "property2": 0
    },
    "created": [
      {
        "kind": "UNSPECIFIED",
        "role": "UNSPECIFIED",
        "resourceId": "string"
      }
    ],
    "requestedBy": "string",
    "createdAt": 0,
    "modifiedAt": 0,
    "appliedAt": 0,
    "confirmedAt": 0,
    "rolledBackAt": 0
  },
  "resources": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "resourceKind": "UNSPECIFIED",
      "resourceId": "string",
      "role": "UNSPECIFIED",
      "ownership": "UNSPECIFIED"
    }
  ],
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "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
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}