FruxonDocs
ApiKnowledge bases

Runs one bounded pass of a source's implementation now.

Scans and processes within ceilings rather than draining the source: a request that names none gets a small default, because the first sync an operator presses is usually against a source that has never run, and finding out whether it works should not cost a whole backlog. Draining is what resuming the schedule does. A paused source syncs — a pause withholds the automatic pass, not the operator's own — and the pass is the automation's own, so it takes the same lock, admits idempotently, and is recorded in the same fire log with its cost. The response echoes the ceilings, because a capped pass and a caught-up source otherwise report the same zeroes.

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

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

Optional per-pass ceilings.

maxAdmit?integer|null

Stop admitting after this many genuinely-new items.

Formatint32
maxDispatch?integer|null

Stop claiming after this many items across every stage of the pass.

Formatint32
[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:sync" \  -H "Content-Type: application/json" \  -d '{}'
{
  "sourceId": "00000000-0000-0000-0000-000000000000",
  "triggerId": "00000000-0000-0000-0000-000000000000",
  "admitted": 0,
  "dispatched": 0,
  "alreadyRunning": false,
  "maxAdmit": 0,
  "maxDispatch": 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
}