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

# Create a policy rule

> Create a new declarative policy rule. Rules are evaluated during detection and the highest-priority matching rule determines the policy_action in the response.



## OpenAPI

````yaml https://api.tuteliq.ai/docs/json post /api/v1/policy/automation/
openapi: 3.1.0
info:
  title: Tuteliq API
  description: >
    # AI-Powered Child Safety API


    You're building a chat feature for a kids' learning app. A user sends a
    message that looks innocuous on the surface but contains subtle grooming
    escalation patterns. Tuteliq catches it, scores the risk by the child's age
    group, and gives your trust & safety team an actionable report — all in
    under 400ms. One API call replaces months of in-house ML work.


    ---


    ## KOSA Harm Categories Coverage


    | Harm Category | Endpoint | Status |

    |--------------|----------|--------|

    | Eating Disorders | `/safety/unsafe` | ✅ Covered |

    | Substance Use | `/safety/unsafe` | ✅ Covered |

    | Suicidal Behaviors | `/safety/unsafe` | ✅ Covered |

    | Depression & Anxiety | `/safety/unsafe` + `/analysis/emotions` | ✅ Covered
    |

    | Compulsive Usage | `/safety/unsafe` | ✅ Covered |

    | Harassment & Bullying | `/safety/bullying` | ✅ Covered |

    | Sexual Exploitation | `/safety/grooming` + `/safety/unsafe` | ✅ Covered |

    | Voice & Audio Threats | `/safety/voice` | ✅ Covered |

    | Visual Content Risks | `/safety/image` | ✅ Covered |


    ---


    ## Key Features


    - **Age-Calibrated Severity** — Risk scores adjust across four age brackets
    (under 10, 10–12, 13–15, 16–17) so moderation matches developmental context.


    - **Nuanced Context Recognition** — Distinguishes hyperbolic teen language
    from genuine crisis signals, dramatically reducing false positives.


    - **Grooming Pattern Detection** — Identifies multi-stage grooming tactics:
    trust escalation, secrecy requests, isolation attempts, and boundary
    violations.


    - **Emotional Trend Analysis** — Tracks persistent mood patterns across
    conversations to surface early indicators of declining mental health.


    - **Voice & Image Analysis** — Upload audio or images for transcription,
    OCR, and full safety analysis in a single call.


    - **Real-time Voice Streaming** — WebSocket endpoint for live audio
    moderation with configurable flush intervals and per-category alerts.


    - **Guidance & Reports** — Generate age-appropriate action plans and
    professional incident reports ready for handoff to human reviewers.


    - **Batch Processing & Webhooks** — Analyze up to 50 items per batch call,
    with HMAC-signed webhook alerts for critical incidents.


    ---


    ## Credits per Action


    | Endpoint | Credits | Notes |

    |----------|---------|-------|

    | `detectBullying` | 1 | Single text analysis |

    | `detectUnsafe` | 1 | Single text analysis |

    | `detectGrooming` | 1 per 10 msgs | `ceil(messages / 10)`, min 1 |

    | `analyzeEmotions` | 1 per 10 msgs | `ceil(messages / 10)`, min 1 |

    | `getActionPlan` | 2 | Longer generation |

    | `generateReport` | 3 | Structured output |

    | `analyzeVoice` | 5 | Transcription + analysis |

    | `analyzeImage` | 3 | Vision + OCR + analysis |


    Every response includes a `credits_used` field. Credit balance is also
    available via the `X-Credits-Remaining` response header.


    ---


    ## Quick Start


    **1.** Get your API key at
    [tuteliq.ai/dashboard](https://tuteliq.ai/dashboard)


    **2.** Install the SDK:


    ```bash

    npm install @tuteliq/sdk

    ```


    **3.** Make your first call:


    ```typescript

    import Tuteliq from '@tuteliq/sdk'


    const tuteliq = new Tuteliq({ apiKey: 'YOUR_API_KEY' })


    const result = await tuteliq.detectUnsafe({
      content: "Don't talk to your parents about us meeting up",
      context: { age_group: "13-15" }
    })


    console.log(result.unsafe)              // true

    console.log(result.categories)          // ["grooming_adjacent", "secrecy"]

    console.log(result.severity)            // "high"

    console.log(result.recommended_action)  // "Escalate to moderator"

    ```


    ---


    ## Performance


    | Metric | Value |

    |--------|-------|

    | Average latency | ~400ms |

    | p95 latency | ~800ms |

    | Uptime SLA | 99.9% |


    Check real-time status at [tuteliq.ai/status](https://tuteliq.ai/status)
  version: 1.0.0
  contact:
    name: Tuteliq Support
    url: https://tuteliq.ai
    email: support@tuteliq.ai
  license:
    name: Proprietary
    url: https://tuteliq.ai/terms
servers:
  - url: https://api.tuteliq.ai
    description: Production server
  - url: http://localhost:3000
    description: Development server
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Safety
    description: >-
      Core detection endpoints for all nine KOSA harm categories. Supports text,
      voice, and image input with age-calibrated severity scoring.
  - name: Fraud
    description: >-
      Financial and social fraud detection — social engineering, app fraud,
      romance scams, and money mule recruitment. Identifies tactics targeting
      minors and vulnerable users with evidence-based scoring.
  - name: Safety Extended
    description: >-
      Extended safety detection — gambling harm, coercive control, vulnerability
      exploitation with cross-endpoint modifiers, and radicalisation. Requires
      Indie tier or above.
  - name: Analyse
    description: >-
      Multi-endpoint analysis. Fan-out a single text to up to 10 detection
      endpoints in parallel with aggregated results, vulnerability modifier
      support, and per-endpoint breakdowns.
  - name: Analysis
    description: >-
      Emotional intelligence endpoints. Analyze conversations for dominant
      emotions, sentiment trends (improving/stable/worsening), and early
      indicators of depression or anxiety. Designed to surface mental health
      risks before they escalate.
  - name: Guidance
    description: >-
      Post-detection action plans tailored by audience. Generate age-appropriate
      guidance for children, parents, or platform trust & safety teams —
      complete with reading-level calibration and tone adjustment. Goes beyond
      "here's a risk score" to answer "what do we do about it?"
  - name: Reports
    description: >-
      Professional incident report generation for schools, counselors, and
      moderators. Converts raw conversation data into structured reports with
      risk levels, categorized findings, and recommended next steps — ready for
      handoff to human reviewers.
  - name: Batch
    description: >-
      Analyze up to 50 items in a single request with optional parallel
      processing. Supports all analysis types (bullying, grooming, unsafe,
      emotions). Built for production pipelines that need to process backlogs or
      moderate content in bulk.
  - name: Webhooks
    description: >-
      Real-time notification endpoints for receiving alerts when critical
      incidents are detected. Full CRUD management with HMAC-SHA256 signed
      payloads, automatic retry on failure, secret regeneration, and test
      delivery — everything you need for production event-driven architectures.
  - name: Usage
    description: >-
      API usage tracking, quota monitoring, and rate limit status. View daily
      summaries, historical trends, per-tool breakdowns, and monthly billing
      period usage. Includes upgrade recommendations when approaching limits.
  - name: Policy
    description: >-
      Customize detection behavior for your use case. Configure sensitivity
      thresholds, category weights, and moderation rules without changing your
      integration code.
  - name: Pricing
    description: >-
      Public pricing plan information. Browse available tiers, features, and
      limits. The public endpoint requires no authentication; detailed plan info
      requires an API key.
  - name: Account
    description: >-
      GDPR-compliant account data management. Exercise the Right to Erasure
      (Article 17), Right to Data Portability (Article 20), and Right to
      Rectification (Article 16). Manage consent records and access your full
      audit trail. Available to all tiers — privacy is not a premium feature.
  - name: Compliance
    description: >-
      Public transparency endpoints for GDPR compliance. Machine-readable Data
      Processing Agreement (DPA), current sub-processor list, and data retention
      schedules. No authentication required — anyone can verify our data
      practices.
  - name: Admin
    description: >-
      Administrative endpoints for breach management and data retention. Log,
      track, and manage data breach incidents with full audit trails and
      notification status tracking. Trigger manual data retention cleanup when
      needed.
  - name: Health
    description: >-
      Health check and monitoring endpoints. Liveness and readiness probes for
      Kubernetes/Cloud Run, full dependency health checks, and detailed
      component status for debugging.
  - name: Status
    description: >-
      Public API status and uptime monitoring. Component-level health (API,
      database, cache, AI engine), uptime percentages, and an embeddable status
      page. Use /status/ping for external monitoring services like UptimeRobot.
externalDocs:
  description: KOSA Compliance Documentation
  url: https://tuteliq.ai/docs/kosa-compliance
paths:
  /api/v1/policy/automation/:
    post:
      tags:
        - Policy Rules
      summary: Create a policy rule
      description: >-
        Create a new declarative policy rule. Rules are evaluated during
        detection and the highest-priority matching rule determines the
        policy_action in the response.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - enabled
                - endpoints
                - conditions
                - action
                - priority
              properties:
                name:
                  type: string
                enabled:
                  type: boolean
                endpoints:
                  type: array
                  items:
                    type: string
                  minItems: 1
                conditions:
                  type: object
                  properties:
                    min_risk_score:
                      type: number
                      minimum: 0
                      maximum: 1
                    min_severity:
                      type: string
                      enum:
                        - low
                        - medium
                        - high
                        - critical
                    categories:
                      type: array
                      items:
                        type: string
                    age_groups:
                      type: array
                      items:
                        type: string
                  additionalProperties: false
                action:
                  type: object
                  required:
                    - type
                  properties:
                    type:
                      type: string
                      enum:
                        - block
                        - flag
                        - escalate
                        - notify
                        - log_only
                    escalate_to:
                      type: string
                    notify_channel:
                      type: string
                    message:
                      type: string
                    override_severity:
                      type: string
                  additionalProperties: false
                priority:
                  type: integer
                  minimum: 0
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  rule:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      enabled:
                        type: boolean
                      endpoints:
                        type: array
                        items:
                          type: string
                      conditions:
                        type: object
                        properties:
                          min_risk_score:
                            type: number
                            minimum: 0
                            maximum: 1
                          min_severity:
                            type: string
                            enum:
                              - low
                              - medium
                              - high
                              - critical
                          categories:
                            type: array
                            items:
                              type: string
                          age_groups:
                            type: array
                            items:
                              type: string
                        additionalProperties: false
                      action:
                        type: object
                        required:
                          - type
                        properties:
                          type:
                            type: string
                            enum:
                              - block
                              - flag
                              - escalate
                              - notify
                              - log_only
                          escalate_to:
                            type: string
                          notify_channel:
                            type: string
                          message:
                            type: string
                          override_severity:
                            type: string
                        additionalProperties: false
                      priority:
                        type: integer
                      created_at:
                        type: string
                      updated_at:
                        type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API key in header

````