FruxonDocs
ApiKnowledge bases

Lists consolidation runs over a knowledge base, newest first.

Every pass ever queued over the knowledge base — manual and scheduled — with its status and, once completed, its report. The options each pass ran with (threshold, cluster size, recent-write window, report-only) are recorded on the run, so a report always reads against what produced it. Most of the history is runs over a report — automatic asks and fact checks, a few groups or facts each — so the newest report is soon pages down. To read one report: `candidateReports=true` with `pageSize=1` for the newest, then `basedOnRunId` for every run that acted on it.

GET
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/consolidations
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
tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

candidateReports?boolean

Only completed manual and scheduled passes that kept to reporting and wrote a report — the ones whose groups a person reviews. Omitted or false lists every kind of run.

basedOnRunId?string

Only the runs that acted on this report: asks, merges, a person's answers and fact checks. They carry what was decided about its groups and facts.

Formatuuid

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/consolidations"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
      "status": "QUEUED",
      "trigger": "MANUAL",
      "consolidationPolicyVersion": 0,
      "consolidationCadence": "MANUAL",
      "consolidationMode": "REPORT_ONLY",
      "requestedBy": "string",
      "reportOnly": false,
      "reportOnlyReason": "string",
      "similarityThreshold": 0,
      "maxClusterSize": 0,
      "recentWriteWindowMinutes": 0,
      "basedOnRunId": "00000000-0000-0000-0000-000000000000",
      "clusterIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "reviewerNote": "string",
      "startedAt": 0,
      "completedAt": 0,
      "error": "string",
      "report": {
        "version": 0,
        "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
        "reportOnly": false,
        "consolidatorAgentId": "string",
        "similarityThreshold": 0,
        "maxClusterSize": 0,
        "recentWriteWindowMinutes": 0,
        "documentsConsidered": 0,
        "documentsSkippedAsRecentlyModified": 0,
        "embeddingsComputed": 0,
        "embeddingsReused": 0,
        "embeddingTokens": 0,
        "embeddingModel": "string",
        "clusters": [],
        "repeatedFacts": [],
        "sectionsCompared": null,
        "repeatedFactsSkippedReason": "string",
        "openingBoilerplate": [],
        "clustersFound": 0,
        "clustersMerged": 0,
        "clustersKeptSeparate": 0,
        "clustersFailed": 0,
        "clustersProposed": 0,
        "clustersRelated": 0,
        "documentsArchived": 0
      },
      "createdAt": 0,
      "modifiedAt": 0
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}