AI Features

Get a column data validation config

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

Request

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

Path parameters

entityIdinteger required

ID of Ai column data validation config

Response

Ai column data validation config record

idinteger

Unique identifier - primary key

columnKeystring

Identifier of the custom field column this validation rule is applied to.

modulestring

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

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

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

promptstring

User-defined instruction sent to the AI describing how the column value should be validated.

enabledboolean

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

includeEmptyFieldsboolean

When true, records with an empty value in the target column are also submitted for validation.

customInputIdinteger

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

Example response

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Changes

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