Built-in tool
Data Transform
Reshape, filter, sort, or combine data.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| actionstring · required | string | required | Data transformation to perform. One of: |
| itemsrepeating-group · required | repeating-group | required | Add one or more data sources. Supports variable references and expressions. |
| pathstring · required if action is json-path | string | required if action is json-path | Dot-notation path to extract from the data. Example: |
| fieldstring · required if action is deduplicate or sort-array or split-out | string | required if action is deduplicate or sort-array or split-out | Reference to each array element, rooted at `item`. Use `item` for the element itself — works for scalar arrays (strings/numbers), not just objects — or `item.field` / `item.address.city` for a nested path. Example: |
| chunkSizenumber · required if action is chunk-array | number | required if action is chunk-array | Number of items per chunk. Must be a positive integer (≥ 1). Default: Example: |
| directionstring · optional | string | optional | Sort direction. Defaults to ascending. Used only when action is sort-array. One of: |
| templatestring · required if action is build-text-template | string | required if action is build-text-template | Text template to render per item. Use item.fieldName to reference fields from the current array element. Example: |
| searchPathstring · required if action is deep-search | string | required if action is deep-search | Dot-notation path to the value to match on. Use [] to traverse arrays. Example: |
| conditionstring · required if action is deep-search | string | required if action is deep-search | One of: |
| matchValuestring · required if action is deep-search and condition is equals or not-equals or contains or starts-with or ends-with | string | required if action is deep-search and condition is equals or not-equals or contains or starts-with or ends-with | Not required when condition is exists or does not exist. Example: |
| extractPathstring · optional | string | optional | Path to extract from matching items. Leave blank to return the full matched item. Used only when action is deep-search. Example: |
| deduplicateResultsboolean · optional | boolean | optional | Remove duplicate values from the output. Used only when action is deep-search. |
| separatorstring · optional | string | optional | Separator/delimiter. For merge-text: placed between each value when joining (default a blank line). For split-text: the delimiter to split on (default a comma). Supports \n for newline. Used only when action is merge-text or split-text or join-array. Example: |
| inputTextstring · required if action is find-and-replace or split-text | string | required if action is find-and-replace or split-text | Input text. For find-and-replace: the text containing patterns to replace. For split-text: the text to split into an array. Example: |
| replacementsrepeating-group · required if action is find-and-replace | repeating-group | required if action is find-and-replace | Find/replace pairs applied in order from top to bottom. |
| caseSensitiveboolean · optional | boolean | optional | When on, matching is case-sensitive. Default is off (case-insensitive). Used only when action is find-and-replace. |
| limitOutputboolean · optional | boolean | optional | When enabled, only returns the first N items after shuffling. Used only when action is shuffle-array. |
| maxItemsnumber · required if limitOutput is true and limitOutput is true | number | required if limitOutput is true and limitOutput is true | Maximum number of items to return from the shuffled array. Must be a positive whole number (≥ 1). Example: |
| pickCountnumber · optional | number | optional | How many items to randomly pick. Must be a whole number (e.g. 1, 2, 3). Default is 1. When set to 1, output is a single object instead of an array. Used only when action is pick-random. Example: |
| outputFieldsstring · required if action is map-array or pick-random and action is map-array | string | required if action is map-array or pick-random and action is map-array | Comma-separated `item`-rooted references to include. For map-array: the projection (a single reference returns an array of scalars, multiple return projected objects). For pick-random: leave blank to return full picked objects. Use `item` for the element itself. Example: |
| conditionsrepeating-group · required if action is filter-array | repeating-group | required if action is filter-array | Conditions to filter array items by. Each row is field + operator + value, where field is rooted at `item` (use `item` for the element itself — scalar arrays included — or `item.field`). Multiple rows combine via the selector below. |
| conditionCombinatorstring · optional | string | optional | How multiple conditions combine. AND keeps items matching every condition; OR keeps items matching any condition. Used only when action is filter-array. One of: Default: |
| assignmentsrepeating-group · required if action is edit-fields | repeating-group | required if action is edit-fields | Add, remove, or rename fields on each item. Supports dotted paths (e.g. "address.city"). |
| keepUnmatchedboolean · optional | boolean | optional | When on, fields not listed above pass through unchanged. Used only when action is edit-fields. Default: |
| includestring · optional | string | optional | Whether to keep sibling fields from the parent object alongside the split value. Used only when action is split-out. One of: Default: |
| destinationFieldNamestring · optional | string | optional | Optional: output the split value under a different field name. Used only when action is split-out. |
| trimItemsboolean · optional | boolean | optional | Trim leading/trailing whitespace from each resulting item. Used only when action is split-text. |
| ignoreEmptyboolean · optional | boolean | optional | Drop empty strings from the result (applied after trimming). Used only when action is split-text. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"success"
],
"properties": {
"count": {
"type": "number",
"description": "Number of items in the result (populated for array results and the count action)."
},
"error": {
"type": "string"
},
"result": {
"description": "Transformed result. Type depends on the action: array, object, scalar, or number."
},
"success": {
"type": "boolean"
}
},
"additionalProperties": false
}
