AI Features

List column data transform configs

get/ai/column-data-transform

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/ai/column-data-transform
  • Auth: HTTP bearer

Query parameters

filterstring

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.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

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.

Response

List of Ai column data transform config records

idinteger

Unique identifier - primary key

columnKeystring

Identifier of the custom field column this transform is applied to.

modulestring

System name of the module (e.g. contact, deal) that owns the column being transformed.

promptstring

User-defined instruction sent to the AI to guide how the column value should be transformed.

enabledboolean

Whether this column data transform is active and will be applied during processing.

provider'platform' | 'websearch' | 'custom'

AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

aiVoiceTone'auto' | 'professional' | 'technical' | 'casual' | 'straightforward' | 'confident' | 'friendly' | 'humorous' | 'inspirational'

Determines the style and attitude in which the generated content is delivered.

aiCreativity'high' | 'medium' | 'low'

Controls how expressive and varied the AI output language is; high allows more creative responses.

customInputIdinteger

ID of the custom field input (Field) this transform is bound to.

type'auto' | 'manual'

Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example response

[
  {
    "id": 42,
    "columnKey": "string",
    "module": "string",
    "prompt": "string",
    "enabled": true,
    "provider": "platform",
    "aiVoiceTone": "auto",
    "aiCreativity": "high",
    "customInputId": 42,
    "type": "auto"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.