Imentiv AI Report API

openapi: 3.2.0
info:
  title: Welcome to Imentiv AI Report API
  description: '# Welcome to Imentiv AI


    Imentiv AI is an advanced Emotion AI platform that leverages deep learning to analyze human emotions across multiple media formats, including video, audio, images, and text.'
  version: 1.0.0
tags:
- name: Report API
  description: 'The Report API provides comprehensive emotion analysis reports in PDF format for analyzed media content.


    **Features:**

    - Generate detailed PDF reports for video emotion analysis

    - Includes visual charts, emotion timelines, and insights

    - Supports asynchronous report generation with callback notifications

    - Retrieve existing reports or trigger new generation


    **Use Cases:** Ideal for creating shareable analysis reports, documentation of emotional insights, and presentation-ready materials.'
paths:
  /v2/reports/pdf/{media_id}:
    get:
      tags:
      - Report API
      summary: Generate Pdf Report
      description: 'Get PDF report if available, or trigger generation if not.


        - Returns PDF metadata if already generated

        - Triggers generation and returns 202 if not available

        - Returns processing status if generation in progress'
      operationId: generate_pdf_report_v2_reports_pdf__media_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: media_id
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier of the media
          title: Media Id
        description: Unique identifier of the media
      - name: media_type
        in: query
        required: true
        schema:
          type: string
          description: 'Type: Only ''video'' is allowed at present'
          title: Media Type
        description: 'Type: Only ''video'' is allowed at present'
      - name: callback_url
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Callback URL for completion notification
          title: Callback Url
        description: Callback URL for completion notification
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key