FruxonDocs
ApiCollection sources

Creates a reusable collection source.

Validates the source config (tool / inline / RAG-index minimum fields) for its kind.

POST
/v1/tenants/{tenant}/collectionSources

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Path Parameters

tenant*string

The tenant identifier

Request Body

The source definition.

displayName?string|null
active?boolean
source?

Item source for a collection pipeline or work shape: a paginated integration list tool, caller-supplied inline records or a knowledge index. cursorParamName controls pagination within one run. cursorPath, watermarkParamName, watermarkFormat and overlapWindowMs support durable progress across runs. Leaving the durable watermark settings null preserves ordinary listing behavior.

inputMapping?

Maps source-item values to agent inputs using dotted paths, such as fields.summary, or {{template}} interpolation.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/collectionSources" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "createdAt": 0,
  "modifiedAt": 0,
  "displayName": "string",
  "active": false,
  "source": {
    "kind": "TOOL",
    "ragAssetId": "string",
    "ragReadMode": "DOCUMENTS",
    "ragSearch": "string",
    "pageSize": 0,
    "integrationConfigId": "string",
    "integrationId": "string",
    "listToolId": "string",
    "getToolId": "string",
    "recordsPath": "string",
    "cursorParamName": "string",
    "totalPath": "string",
    "pageOrder": "SOURCE_ORDER",
    "parameters": {},
    "itemIdPath": "string",
    "itemVersionPath": "string",
    "previousVersionField": "string",
    "sinkTargetPath": "string",
    "sinkTargetKind": "ROW",
    "skipWhen": {
      "match": "ALL",
      "conditions": []
    },
    "sourceUrlPath": "string",
    "cursorPath": "string",
    "watermarkParamName": "string",
    "watermarkFormat": "RAW",
    "overlapWindowMs": 0,
    "startFrom": 0,
    "flattenSheetRows": false
  },
  "inputMapping": {
    "userQuery": "string",
    "parameters": {},
    "attachmentUrlPath": "string"
  }
}
{
  "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
}