FruxonDocs
ApiKnowledge bases

Shows what a source would read, admitting nothing.

The question between creating a source and letting it loose on a customer's history — which is why a newly provisioned source waits paused. It lists the source the way a real pass would and compares each item against the ledger, so an item reported new is one the next pass would admit, and no cursor moves. The listing is not narrowed by the watermark, because a caught-up source would then come back empty and read as broken; each item says separately whether the next pass would reach it. Items are identified and labelled, never reproduced: a conversation record is a transcript, and this surface is read by whoever owns the corpus rather than whoever has access to the source system. Ask for a count instead of a sample to see how much is waiting, which is what actually gates enabling a source.

GET
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/sources/{source}:preview

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

Query Parameters

Limit?integer

How many items to sample. Defaults to a glance; capped, because this drives a live list call against a customer's system on a button press.

Formatint32
CountOnly?boolean

Count what is waiting instead of listing a sample of it.

The other half of "what am I accepting". A sample says whether the source is wired up and what its items look like; the count says how much of it there is, which is what a conversation source is really being asked before its schedule is allowed to spend money on the whole corpus.

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08:preview"
{
  "sourceId": "00000000-0000-0000-0000-000000000000",
  "available": false,
  "unavailable": "string",
  "triggerId": "00000000-0000-0000-0000-000000000000",
  "doorId": "string",
  "integrationConfigId": "string",
  "pageOrder": "SOURCE_ORDER",
  "items": [
    {
      "index": 0,
      "itemKey": "string",
      "label": "string",
      "state": "UNKNOWN",
      "withinBound": false
    }
  ],
  "truncated": false,
  "waiting": {
    "total": 0,
    "filtered": 0,
    "alreadyHeld": 0,
    "truncated": 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
}