AI Features

Get a column data transform config

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

Request

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

Path parameters

entityIdinteger required

ID of Ai column data transform config

Response

Ai column data transform config record

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.