AIFeatures

> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.

Record handle: ref(id) → a lazy handle to one ColumnDataTransform (get/update/delete, field values, related records). See record handles.

`createAiColumnDataTransform`

POST /ai/column-data-transform/{entityId}

Create a column data transform config

Parameter	In	Required	Description
`entityId`	path	yes
`body`	body	yes

Returns: ColumnDataTransform · Cost: 1 API call.

`createAiColumnDataValidationResult`

POST /ai/column-data-validation-result

Create a column data validation result

Parameter	In	Required	Description
`body`	body	yes

Returns: ColumnDataValidationResult · Cost: 1 API call.

`createColumnDataValidation`

POST /ai/column-data-validation

Create a column data validation config

Parameter	In	Required	Description
`body`	body	yes

Returns: ColumnDataValidation · Cost: 1 API call.

`createValidateCalculationFunction`

POST /validate-calculation-function

Validate a field calculation formula — Validates a field calculation formula against the supplied parameters. Returns a success flag and an error message if validation fails.

Parameter	In	Required	Description
`body`	body	yes

Returns: void · Cost: 1 API call.

`deleteAiColumnDataTransform`

DELETE /ai/column-data-transform/{entityId}

Delete a column data transform config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data transform config

Returns: any · Cost: 1 API call.

`deleteAiColumnDataValidation`

DELETE /ai/column-data-validation/{entityId}

Delete a column data validation config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config

Returns: any · Cost: 1 API call.

`deleteAiColumnDataValidationResult`

DELETE /ai/column-data-validation-result/{entityId}

Delete a column data validation result

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation result config

Returns: any · Cost: 1 API call.

`executeAiColumnDataValidation`

POST /ai/column-data-validation/{entityId}/execute

Execute a column data validation on demand

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config
`body`	body	yes

Returns: void · Cost: 1 API call.

`executeColumnDataTransform`

POST /column-data-transform/{entityId}/execute

Execute a column data transform on demand — Applies a saved column data transform rule to a batch of record IDs, rewriting each record's custom field value according to the configured AI prompt. Requires sufficient AI token balance.

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config
`body`	body	yes

Returns: void · Cost: 1 API call.

`generateCustomField`

POST /ai/generate-custom-field

Generate a value for a custom field using AI — Generates a value for a custom field using AI based on the provided prompt and module context. Requires sufficient AI token balance.

Parameter	In	Required	Description
`body`	body	yes

Returns: any · Cost: 1 API call.

`generateModules`

POST /ai/generate-custom-modules

Generate module definitions using AI — Generates module definitions using AI from a single prompt. Requires sufficient AI token balance.

Parameter	In	Required	Description
`body`	body	yes

Returns: any · Cost: 1 API call.

`getAiColumnDataTransform`

GET /ai/column-data-transform/{entityId}

Get a column data transform config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data transform config

Returns: ColumnDataTransform · Cost: 1 API call.

`getAiColumnDataValidation`

GET /ai/column-data-validation/{entityId}

Get a column data validation config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config

Returns: ColumnDataValidation · Cost: 1 API call.

`getAiColumnDataValidationResult`

GET /ai/column-data-validation-result/{entityId}

Get a column data validation result

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation result config

Returns: ColumnDataValidationResult · Cost: 1 API call.

`getFieldGenerate`

GET /field/generate/{fieldId}

Generate a value for a field using AI — Uses AI to generate values for one or more fields on a given entity. entityId may be a single ID or a JSON-encoded array. Requires edit permissions on the entity and sufficient AI token balance.

Parameter	In	Required	Description
`fieldId`	path	yes	A JSON-encoded list of IDs or a single field ID.
`entityModule`	query	yes	Module of field value
`entityId`	query	yes	Id of field value

Returns: void · Cost: 1 API call.

`listAiColumnDataTransform`

GET /ai/column-data-transform

List column data transform configs

Parameter	In	Required	Description
`filter`	query	no	Filter expression to narrow results. Format: `field operator value`. Multiple conditions are joined with `;` or `&` (AND) or `\|` (OR). Conditions can be grouped with parentheses. Supported operators: `=` (equals; also matches NULL when value is empty), `!=` (not equals), `>`, `>=`, `<`, `<=`, `~` (LIKE, use `%` as wildcard; empty value matches NULL/empty), `!~` (NOT LIKE), `...` (IN set, comma-separated: `statusId...1,2,3`). OR across values for one field: `status=(active\|pending)`. Examples: `filter=name=Acme`, `filter=created>=2024-01-01;assigneeId=`, `filter=name~%smith%;statusId...1,2,3`, `filter=(status=active\|status=pending)&spaceId=5`.
`offset`	query	no	Zero-based index of the first record to return. Use together with `limit` for pagination. Example: `offset=20&limit=10` returns records 21–30.
`limit`	query	no	Maximum number of records to return. Use together with `offset` for pagination.
`order`	query	no	Sort order for results. Comma-separated list of `field;DIRECTION` pairs. Direction is `ASC` or `DESC` (default `DESC` when omitted). Example: `order=name;ASC` or `order=id;ASC,name;DESC`.

Returns: list<ColumnDataTransform> · Cost: 1 API call per page (lazy paginator).

`listAiColumnDataValidation`

GET /ai/column-data-validation

List column data validation configs

Parameter	In	Required	Description
`filter`	query	no	Filter expression to narrow results. Format: `field operator value`. Multiple conditions are joined with `;` or `&` (AND) or `\|` (OR). Conditions can be grouped with parentheses. Supported operators: `=` (equals; also matches NULL when value is empty), `!=` (not equals), `>`, `>=`, `<`, `<=`, `~` (LIKE, use `%` as wildcard; empty value matches NULL/empty), `!~` (NOT LIKE), `...` (IN set, comma-separated: `statusId...1,2,3`). OR across values for one field: `status=(active\|pending)`. Examples: `filter=name=Acme`, `filter=created>=2024-01-01;assigneeId=`, `filter=name~%smith%;statusId...1,2,3`, `filter=(status=active\|status=pending)&spaceId=5`.
`offset`	query	no	Zero-based index of the first record to return. Use together with `limit` for pagination. Example: `offset=20&limit=10` returns records 21–30.
`limit`	query	no	Maximum number of records to return. Use together with `offset` for pagination.
`order`	query	no	Sort order for results. Comma-separated list of `field;DIRECTION` pairs. Direction is `ASC` or `DESC` (default `DESC` when omitted). Example: `order=name;ASC` or `order=id;ASC,name;DESC`.

Returns: list<ColumnDataValidation> · Cost: 1 API call per page (lazy paginator).

`listAiColumnDataValidationResults`

GET /ai/column-data-validation-result

List column data validation results

Parameter	In	Required	Description
`filter`	query	no	Filter expression to narrow results. Format: `field operator value`. Multiple conditions are joined with `;` or `&` (AND) or `\|` (OR). Conditions can be grouped with parentheses. Supported operators: `=` (equals; also matches NULL when value is empty), `!=` (not equals), `>`, `>=`, `<`, `<=`, `~` (LIKE, use `%` as wildcard; empty value matches NULL/empty), `!~` (NOT LIKE), `...` (IN set, comma-separated: `statusId...1,2,3`). OR across values for one field: `status=(active\|pending)`. Examples: `filter=name=Acme`, `filter=created>=2024-01-01;assigneeId=`, `filter=name~%smith%;statusId...1,2,3`, `filter=(status=active\|status=pending)&spaceId=5`.
`offset`	query	no	Zero-based index of the first record to return. Use together with `limit` for pagination. Example: `offset=20&limit=10` returns records 21–30.
`limit`	query	no	Maximum number of records to return. Use together with `offset` for pagination.
`order`	query	no	Sort order for results. Comma-separated list of `field;DIRECTION` pairs. Direction is `ASC` or `DESC` (default `DESC` when omitted). Example: `order=name;ASC` or `order=id;ASC,name;DESC`.

Returns: list<ColumnDataValidationResult> · Cost: 1 API call per page (lazy paginator).

`previewColumnDataTransform`

POST /column-data-transform/{entityId}/preview

Preview a column data transform without saving — Performs a one-time transformation on a single preview object using a custom prompt, without saving any configuration. Useful for testing prompts before creating a transform rule.

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config
`body`	body	yes

Returns: void · Cost: 1 API call.

`updateAiColumnDataTransform`

PUT /ai/column-data-transform/{entityId}

Update a column data transform config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data transform config
`body`	body	yes

Returns: ColumnDataTransform · Cost: 1 API call.

`updateAiColumnDataValidationResult`

PUT /ai/column-data-validation-result/{entityId}

Update a column data validation result

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation result config
`body`	body	yes

Returns: ColumnDataValidationResult · Cost: 1 API call.

`updateColumnDataValidation`

PUT /ai/column-data-validation/{entityId}

Update a column data validation config

Parameter	In	Required	Description
`entityId`	path	yes	ID of Ai column data validation config
`body`	body	yes

Returns: ColumnDataValidation · Cost: 1 API call.

SDK API reference

Authentication