> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kadoa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate targeted rules

> Create specific validation rules targeting particular data fields or patterns using AI analysis



## OpenAPI

````yaml post /v4/data-validation/rules/actions/generate
openapi: 3.0.3
info:
  title: Kadoa API
  version: 3.0.0
  contact:
    name: Support
    email: support@kadoa.com
servers:
  - url: https://api.kadoa.com
security: []
paths:
  /v4/data-validation/rules/actions/generate:
    post:
      tags:
        - Data Validation
        - Rules Library
      description: Generate a validation rule using AI
      parameters: []
      requestBody:
        description: Body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateRule'
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateRuleResponse'
        '401':
          description: Unauthorized - Authentication required or failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    description: Indicates an error occurred
                    example: true
                  message:
                    type: string
                    description: Error message
                    example: Authentication required
                required:
                  - error
                  - message
        '500':
          description: Internal Server Error - Unexpected system error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    description: Indicates an error occurred
                    example: true
                  message:
                    type: string
                    description: Error message
                    example: Internal server error
                  details:
                    type: object
                    description: Additional error details
                required:
                  - error
                  - message
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GenerateRule:
      type: object
      properties:
        jobId:
          type: string
        userPrompt:
          type: string
          minLength: 1
        selectedColumns:
          type: array
          items:
            type: string
        workflowId:
          type: string
        isPreviewRun:
          type: boolean
      required:
        - userPrompt
        - workflowId
      title: GenerateRule
      description: Rule generation request with user description
    GenerateRuleResponse:
      type: object
      properties:
        error:
          type: boolean
          enum:
            - false
        message:
          type: string
        data:
          $ref: '#/components/schemas/Rule'
        metadata:
          type: object
          properties:
            sampleDataCount:
              type: number
            schemaFieldsCount:
              type: number
      required:
        - error
        - message
        - data
      title: GenerateRuleResponse
      description: AI-generated rule with creation metadata
    Rule:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier
          example: abc123
        name:
          type: string
          description: Human-readable rule name
          example: Email Validation Rule
        description:
          type: string
        ruleType:
          type: string
          enum:
            - custom_sql
        workflowId:
          type: string
        groupId:
          type: string
        userId:
          type: string
        teamId:
          type: string
        targetColumns:
          type: array
          items:
            type: string
        parameters:
          type: object
          properties:
            sql:
              type: string
            params:
              type: array
              items:
                nullable: true
            prompt:
              type: string
          required:
            - sql
        status:
          type: string
          enum:
            - preview
            - enabled
            - disabled
        source:
          type: string
          enum:
            - user_input
            - ai_agent
            - preview_suggestion
            - unknown
        disabledReason:
          type: string
          nullable: true
        metadata:
          type: object
          additionalProperties:
            nullable: true
        createdAt:
          type: string
          description: ISO 8601 timestamp
          example: '2024-01-15T10:30:00.000Z'
        updatedAt:
          type: string
          description: ISO 8601 timestamp
          example: '2024-01-15T10:30:00.000Z'
        deletedAt:
          type: string
          description: ISO 8601 timestamp
          example: '2024-01-15T10:30:00.000Z'
          nullable: true
        deletedReason:
          type: string
          nullable: true
      required:
        - id
        - name
        - status
        - createdAt
        - updatedAt
      title: Rule
      description: Complete validation rule with metadata and lifecycle information
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication

````