POST
/
v4
/
data-validation
/
rules
/
actions
/
generate
cURL
curl --request POST \
  --url https://api.kadoa.com/v4/data-validation/rules/actions/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "jobId": "<string>",
  "userPrompt": "<string>",
  "selectedColumns": [
    "<string>"
  ],
  "workflowId": "<string>",
  "isPreviewRun": true
}'
{
  "error": true,
  "message": "<string>",
  "data": {
    "id": "abc123",
    "name": "Email Validation Rule",
    "description": "<string>",
    "ruleType": "custom_sql",
    "workflowId": "<string>",
    "groupId": "<string>",
    "userId": "<string>",
    "teamId": "<string>",
    "targetColumns": [
      "<string>"
    ],
    "parameters": {
      "sql": "<string>",
      "params": [
        "<any>"
      ],
      "prompt": "<string>"
    },
    "status": "enabled",
    "disabledReason": "<string>",
    "metadata": {},
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "deletedAt": "2024-01-15T10:30:00.000Z",
    "deletedReason": "<string>"
  },
  "metadata": {
    "sampleDataCount": 123,
    "schemaFieldsCount": 123
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json

Body

Rule generation request with user description

userPrompt
string
required
Minimum length: 1
workflowId
string
required
jobId
string
selectedColumns
string[]
isPreviewRun
boolean

Response

200

AI-generated rule with creation metadata

error
boolean
required
message
string
required
data
object
required

Complete validation rule with metadata and lifecycle information

metadata
object