intencheck-com Demo API

openapi: 3.2.0
info:
  title: IntenCheck Demo API
  description: 'IntenCheck provides a comprehensive suite of Deep NLP text analysis endpoints that detect meta-programs, emotions, moods, and communication styles.

    It supports multiple input and output languages natively.


    ## Quick Start


    1. **Get your API Key** from the developer dashboard.

    2. **Analyze Text** to get a psychological profile.

    3. **Generate a Reply** using the analysis context to match or adjust styles.


    ## Authentication

    All non-demo API endpoints require authentication via an API key. Pass it in your headers:

    - `X-API-Key: YOUR_KEY`

    - `Authorization: Bearer YOUR_KEY`


    ## Code Examples


    **1. Analyze Text (Python / cURL)**


    ```bash

    curl -X ''POST'' \

    ''https://intencheck.com/api/v1/analyze'' \

    -H ''accept: application/json'' \

    -H ''Authorization: Bearer YOUR_API_KEY'' \

    -H ''Content-Type: application/json'' \

    -d ''{

    "text": "I am so frustrated that you never listen to my feedback!",

    "features": ["emotions", "communication_style"],

    "output_lang": "en"

    }''

    ```


    **2. Generate a Reply**


    ```bash

    curl -X ''POST'' \

    ''https://intencheck.com/api/v1/reply'' \

    -H ''accept: application/json'' \

    -H ''Authorization: Bearer YOUR_API_KEY'' \

    -H ''Content-Type: application/json'' \

    -d ''{

    "original_text": "I am so frustrated that you never listen to my feedback!",

    "analysis_data": { ... result from /analyze ... },

    "strategy": "de_escalate",

    "mode": "constructive"

    }''

    ```


    ## Common Error Codes

    | Status | Description |

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

    | `400` | Bad Request: Invalid parameters or JSON schema. |

    | `401` | Unauthorized: Missing or invalid API Key. |

    | `402` | Payment Required: Insufficient prepaid balance. |

    | `429` | Too Many Requests: Rate limit exceeded. |

    | `500` | Internal Server Error / Upstream AI failure. |'
  contact:
    name: IntenCheck Developer Support
    url: https://intencheck.com/
  version: 1.1.0
tags:
- name: Demo
paths:
  /api/v1/demo/analyze:
    post:
      summary: Demo Analyze Text
      description: Public endpoint for the landing page demo. Strict rate limit, no billing.
      operationId: demo_analyze_text_api_v1_demo_analyze_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompactAnalyzeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Demo
  /api/v1/demo/reply:
    post:
      summary: Demo Generate Reply
      description: Public endpoint for the landing page demo reply generation.
      operationId: demo_generate_reply_api_v1_demo_reply_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplyResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Demo
components:
  schemas:
    CompactCommunicationStyles:
      properties:
        ws:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Warm / Supportive
        cd:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Cold / Distant
        as:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Assertive
        agg:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Aggressive
        ps:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Passive
        pag:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Passive-Aggressive
        cdom:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Controlling / Dominant
        aa:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Accommodating / Adaptive
      type: object
      required:
      - ws
      - cd
      - as
      - agg
      - ps
      - pag
      - cdom
      - aa
      title: CompactCommunicationStyles
    CompactMetaprogramPair:
      properties:
        ls:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ls
          description: Left side score
        rs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Rs
          description: Right side score
        d:
          type: boolean
          title: D
          default: true
      type: object
      title: CompactMetaprogramPair
    CustomParameters:
      properties:
        target_tone:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Tone
          description: Desired tone for the generated reply or rewrite.
        target_mood:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Mood
          description: Desired emotional mood for the generated reply or rewrite.
        target_communication_style:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Communication Style
          description: Desired communication style, such as assertive, warm, neutral, or diplomatic.
        metaprograms:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Metaprograms
          description: Optional target metaprogram adjustments keyed by metaprogram name.
      type: object
      title: CustomParameters
    CompactAnalysisResult-Output:
      properties:
        mp:
          anyOf:
          - $ref: '#/components/schemas/CompactMetaprograms'
          - type: 'null'
        e:
          anyOf:
          - $ref: '#/components/schemas/CompactEmotions'
          - type: 'null'
        m:
          anyOf:
          - $ref: '#/components/schemas/CompactMoods'
          - type: 'null'
        cs:
          anyOf:
          - $ref: '#/components/schemas/CompactCommunicationStyles'
          - type: 'null'
        tp:
          anyOf:
          - $ref: '#/components/schemas/CompactToneAndPosture'
          - type: 'null'
        s:
          anyOf:
          - $ref: '#/components/schemas/SentimentResult'
          - type: 'null'
      type: object
      title: CompactAnalysisResult
    SentimentResult:
      properties:
        sentiment:
          type: string
          title: Sentiment
          description: Overall sentiment (Positive, Negative, Neutral)
        score:
          type: integer
          title: Score
          description: Score from 1 (very negative) to 10 (very positive)
        explanation:
          type: string
          title: Explanation
          description: Brief explanation of the sentiment
      type: object
      required:
      - sentiment
      - score
      - explanation
      title: SentimentResult
    ReplyRequest:
      properties:
        original_text:
          type: string
          minLength: 1
          title: Original Text
          description: Source text that should be answered or rewritten. The request is billed by this text's word count.
        analysis_data:
          $ref: '#/components/schemas/CompactAnalysisResult-Input'
          description: Analysis result for the original text. Usually pass the output from analyze_text so the reply generator can align tone, emotion, and style.
        strategy:
          type: string
          enum:
          - analogous
          - opposite
          - analogous_plus_vector
          - custom
          title: Strategy
          description: Reply strategy. 'analogous' mirrors the detected style, 'opposite' counterbalances it, 'analogous_plus_vector' follows vector_instructions, and 'custom' follows custom_parameters.
        mode:
          type: string
          enum:
          - reply
          - rewrite
          title: Mode
          description: '''reply'' generates an answer; ''rewrite'' rewrites the original text.'
          default: reply
        vector_instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Vector Instructions
          description: Additional direction used only with strategy='analogous_plus_vector'.
        custom_parameters:
          anyOf:
          - $ref: '#/components/schemas/CustomParameters'
          - type: 'null'
          description: Target tone, mood, style, or metaprogram settings used only with strategy='custom'.
        target_language:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Language
          description: Optional ISO 639-1 output language. If omitted, the generated text uses the source text's language.
      type: object
      required:
      - original_text
      - analysis_data
      - strategy
      title: ReplyRequest
      examples:
      - analysis_data:
          emotions:
            anger_irritation_frustration:
              detected: true
              value: 9
            calm_relaxation:
              detected: false
              value: 1
        custom_parameters:
          target_communication_style: Assertive
          target_tone: Neutral
        mode: rewrite
        original_text: I will not accept these terms under any condition.
        strategy: custom
    CompactMoods:
      properties:
        up:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Uplifted / Playful
        cn:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Calm / Neutral
        irr:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Irritable
        gd:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Gloomy / Depressed
        wt:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Worried / Tense
        cs:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Cynical / Skeptical
        ei:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Enthusiastic / Inspired
        ta:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Tired / Apathetic
      type: object
      required:
      - up
      - cn
      - irr
      - gd
      - wt
      - cs
      - ei
      - ta
      title: CompactMoods
    CompactMetaprograms:
      properties:
        ta:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Toward vs Away
        ie:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Internal vs External
        mm:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Matching vs Mismatching
        gs:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Global vs Specific
        op:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Options vs Procedures
        pn:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Possibility vs Necessity
        pr:
          $ref: '#/components/schemas/CompactMetaprogramPair'
          description: Proactive vs Reactive
      type: object
      required:
      - ta
      - ie
      - mm
      - gs
      - op
      - pn
      - pr
      title: CompactMetaprograms
    CompactEmotions:
      properties:
        js:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Joy / Satisfaction
        cr:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Calm / Relaxation
        ic:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Interest / Curiosity
        sc:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Surprise / Confusion
        sd:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Sadness / Disappointment
        aif:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Anger / Irritation / Frustration
        fat:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Fear / Anxiety / Tension
        sga:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Shame / Guilt / Awkwardness
        dc:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Disgust / Contempt
        er:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Envy / Resentment
      type: object
      required:
      - js
      - cr
      - ic
      - sc
      - sd
      - aif
      - fat
      - sga
      - dc
      - er
      title: CompactEmotions
    CompactAnalyzeResponse:
      properties:
        a:
          $ref: '#/components/schemas/CompactAnalysisResult-Output'
      type: object
      required:
      - a
      title: CompactAnalyzeResponse
    CompactParameterScore:
      properties:
        v:
          anyOf:
          - type: integer
          - type: 'null'
          title: V
          description: Score 1-10
        d:
          type: boolean
          title: D
          description: Detected
          default: true
      type: object
      title: CompactParameterScore
    AnalyzeRequest:
      properties:
        text:
          type: string
          minLength: 1
          title: Text
          description: Text to analyze. Use natural-language user text, review text, messages, email copy, support conversations, or other customer-facing copy. The request is billed by word count.
        features:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Features
          description: 'Optional feature families to include. Supported values: metaprograms, emotions, moods, communication_styles, tone_and_posture. Omit this field to run the full analysis.'
        output_lang:
          anyOf:
          - type: string
          - type: 'null'
          title: Output Lang
          description: ISO 639-1 language code for labels and explanations in the response, for example 'en', 'lt', 'fr', or 'de'. Defaults to Lithuanian ('lt').
          default: lt
      type: object
      required:
      - text
      title: AnalyzeRequest
      examples:
      - features:
        - emotions
        - communication_styles
        output_lang: en
        text: I am so frustrated that you never listen to my feedback!
    CompactToneAndPosture:
      properties:
        gn:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Gentle
        neu:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Neutral
        hd:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Hard
        ang:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Angry
        mo:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Mocking
        sar:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Sarcastic
        iro:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Ironic
        pat:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Patronizing
        ac:
          $ref: '#/components/schemas/CompactParameterScore'
          description: Affectionate / Caring
      type: object
      required:
      - gn
      - neu
      - hd
      - ang
      - mo
      - sar
      - iro
      - pat
      - ac
      title: CompactToneAndPosture
    ReplyResponse:
      properties:
        generated_reply:
          type: string
          title: Generated Reply
      type: object
      required:
      - generated_reply
      title: ReplyResponse
    CompactAnalysisResult-Input:
      properties:
        mp:
          anyOf:
          - $ref: '#/components/schemas/CompactMetaprograms'
          - type: 'null'
        e:
          anyOf:
          - $ref: '#/components/schemas/CompactEmotions'
          - type: 'null'
        m:
          anyOf:
          - $ref: '#/components/schemas/CompactMoods'
          - type: 'null'
        cs:
          anyOf:
          - $ref: '#/components/schemas/CompactCommunicationStyles'
          - type: 'null'
        tp:
          anyOf:
          - $ref: '#/components/schemas/CompactToneAndPosture'
          - type: 'null'
        s:
          anyOf:
          - $ref: '#/components/schemas/SentimentResult'
          - type: 'null'
      type: object
      title: CompactAnalysisResult
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/auth/login