FruxonDocs
IntegrationsAssets

Fetches one sample record from a tool-source's list tool so the configure UI can offer the record's fields as a picker

Invokes the configured list tool once (single page) against the referenced integration config and returns the first record it yields, so the asset-configuration UI can present the record's fields as a field picker before the producer asset is created. The probe is read-only: nothing is persisted and no asset is provisioned. Supply `recordsPath` when the list tool returns the records nested inside a page envelope rather than as the top-level array. Returns a null `record` when the tool yields no rows; responds 400 when the integration config or list tool is missing.

POST
/v1/tenants/{tenant}/assets:sampleToolSource

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 integration config + list tool to probe (and optional records path).

integrationConfigId*string|null
listToolId*string|null
recordsPath?string|null

Dotted path to the records array within a page; omit when the page is itself the array.

cursorParamName?string|null

Cursor request-parameter name; unused for sampling (single page) but accepted for parity.

parameters?|null

Static tool input args (e.g. a Google Sheet's spreadsheet_id / sheet_name) — without these a targeted source (a specific sheet/table) can't be sampled.

flattenSheetRows?boolean

Flatten Google Sheets sheet_read rows to header-keyed records, so the sampled fields match what the run will map.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/assets:sampleToolSource" \  -H "Content-Type: application/json" \  -d '{    "integrationConfigId": "string",    "listToolId": "string"  }'
{
  "record": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty

Regenerates the webhook URL for an asset with auto-update enabled

Rotates the webhook secret backing the asset's auto-update subscription: the previous URL stops accepting deliveries immediately. The new URL is returned only on this response, so capture it before navigating away. Only valid for assets created with auto-update enabled against a manual-registration provider; returns 400 otherwise. After rotation the user must reconfigure the source system to point at the new URL.

Runs a semantic or full-text search against a single asset's indexed documents

Executes a vector, full-text, or hybrid (RRF) query restricted to one asset and returns ranked chunks with scores. The asset must have completed at least one successful ingestion (`/operations` reports `Completed`) before results are meaningful. Primarily a debugging and tuning surface: agents at runtime issue cross-asset searches through the agent pipeline, not this endpoint. `VectorWeight`, `FtsWeight`, and `RrfK` are only consulted in hybrid mode; `ScoreThreshold` filters results post-ranking. Subject to per-tenant concurrency limits.