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

# Classifica un video

> Invia un video per la classificazione

🔁 Il formato della risposta dipende dall'header `Accept`:

`Accept: application/json` → `{ "identifier": "..." }`

 Altri valori (ad es. `text/plain`) → testo semplice con la sola stringa dell'identificativo.



## OpenAPI

````yaml it/api-reference/api-swagger-dev-documentation.json POST /api/classification_video
openapi: 3.0.0
info:
  title: API di identifAI
  version: 1.0.0
  description: >-
    API per integrare le funzionalità di classificazione di immagini e video di
    identifAI.<br><details><summary>**Come ottenere la tua API
    key**</summary>Per ottenere la tua API key, segui questi semplici
    passaggi:   <ol><li><p>**Crea un profilo utente e accedi alla
    piattaforma**</p>Se non hai ancora un account, visita la nostra piattaforma
    e crea un profilo utente. Dopo aver completato la registrazione e verificato
    la tua e-mail, accedi con le tue credenziali.</li><li><p>**Apri il menu
    utente**</p>Dopo l'accesso, fai clic sul tuo nome o sull'icona utente in
    alto a destra nello schermo.</li><li><p>**Seleziona la voce API key**</p>Nel
    menu a tendina che compare, seleziona la voce "Api-Key". Da lì puoi
    visualizzare o generare la tua API key.</li></ol>Ora sei pronto per usare la
    tua API key con la nostra API!</details><details><summary>**Come usare
    l'API**</summary>Per usare l'API, effettua prima una richiesta **POST** per
    avviare la classificazione. Poi usa l'***identificativo*** restituito dalla
    richiesta **POST** per recuperare i risultati.

    <details>

    <summary>**1. Classificazione delle immagini**</summary>
      * Per classificare un'immagine, effettua una richiesta **POST** a `/api/classification` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
      * Nella risposta riceverai l'***identificativo*** dell'immagine classificata.
      * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
      * La risposta contiene i risultati della classificazione dell'immagine in formato JSON.<br>Nella risposta trovi un array ***results***, con i risultati della classificazione di ogni modello usato, e un array ***verdicts***, con i risultati di ogni euristica applicata.<br>Se la classificazione non è ancora completa, continua a inviare la richiesta **GET** finché il risultato non è disponibile.</details><details><summary>**2. Classificazione dei video**</summary>
        * Per classificare un video, effettua una richiesta **POST** a `/api/classification_video` con i parametri richiesti (per i dettagli sui parametri consulta la sezione *"Classificazione"* qui sotto).
        * Nella risposta riceverai l'***identificativo*** del video classificato.
        * Usa l'***identificativo*** ricevuto per recuperare i risultati della classificazione con una richiesta **GET** a `/api/classification_video/{identifier}` (per i dettagli su come strutturare la richiesta consulta la sezione *"Classificazione"* qui sotto).
        * La risposta contiene i risultati della classificazione del video in formato JSON. Per la classificazione, il video viene suddiviso in *frame*.<br> Nella risposta trovi un array ***results***, con l'esito della classificazione di ogni modello applicato a ogni frame analizzato, e un array ***verdicts***, con i risultati di ogni euristica usata.<br> Se la classificazione non è completa, continua a inviare la richiesta **GET** finché non vengono restituiti i risultati finali.</details><details><summary>**3. Tutte le classificazioni**</summary>L'endpoint `/api/classifications` restituisce tutte le classificazioni di immagini effettuate da un utente, con i risultati di tutte le richieste di classificazione di immagini passate.</details><details><summary>**4. Gestione degli utenti**</summary>  L'endpoint **POST** `/api/user` permette di creare un utente, mentre l'endpoint **DELETE** `/api/user` serve a eliminare un utente (per la struttura delle richieste consulta la sezione sugli utenti qui sotto).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Route di classificazione
  - name: Infrastructure
    description: Route dell'infrastruttura
  - name: User
    description: Azioni dell'utente
  - name: Partner
    description: Azioni dei partner
paths:
  /api/classification_video:
    post:
      tags:
        - Classification
      summary: Classifica un video
      description: |-
        Invia un video per la classificazione

        🔁 Il formato della risposta dipende dall'header `Accept`:

        `Accept: application/json` → `{ "identifier": "..." }`

         Altri valori (ad es. `text/plain`) → testo semplice con la sola stringa dell'identificativo.
      parameters:
        - name: Accept
          in: header
          description: >-
            Tipo di contenuto della risposta. Valori supportati:
            application/json, text/plain.
          required: false
          schema:
            type: string
            enum:
              - application/json
              - text/plain
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                video:
                  type: string
                  format: binary
                  description: >-
                    Il video da classificare. **Formati supportati:** qualsiasi
                    formato video (MP4, AVI, MOV, ecc.). **Tipi MIME:**
                    qualsiasi tipo MIME che inizia con 'video/' (ad es.
                    video/mp4, video/avi, video/quicktime). **Dimensione massima
                    del file:** 50MB.
                ref_id:
                  type: string
                  description: >-
                    ID di riferimento facoltativo da associare alla richiesta di
                    classificazione.
                frames:
                  type: integer
                  enum:
                    - 5
                    - 10
                    - 30
                  description: Scegli di classificare al massimo 5, 10 o 30 frame.
                key_frames:
                  type: boolean
                  description: >-
                    Se impostato a true, estrae i keyframe e li usa per la
                    classificazione al posto di immagini a distanza di tempo
                    fissa. I keyframe estratti possono essere meno dei `frames`
                    richiesti. Ignorato quando è presente
                    `ensure_face_per_frame` o `frames_timestamps`.
                key_frames_method:
                  type: string
                  enum:
                    - iframes
                    - flow
                    - color
                  description: >-
                    Algoritmo di identificazione dei keyframe. I valori
                    possibili sono **iframes** (predefinito), **flow** e
                    **color**.
                     - `iframes` : estrae gli iframe del video; 
                     - `color` : restituisce il frame medio, in base al colore, di ogni sequenza di inquadratura. Le *sequenze di inquadratura* sono gruppi di frame che iniziano con un iframe; 
                     - `flow` : restituisce il frame più statico rispetto al frame precedente di ogni sequenza di inquadratura.
                with_tampering:
                  type: boolean
                  description: >-
                    Impostalo a true se vuoi analizzare anche i segni di
                    manomissione o manipolazione dell'immagine effettuate senza
                    l'aiuto di un'IA generativa.
                with_morphing:
                  type: boolean
                  description: >-
                    Impostalo a true se vuoi analizzare anche i volti delle
                    persone nell'immagine con il morphing.
                with_audio:
                  type: boolean
                  description: >-
                    **[BETA]** Impostalo a true se vuoi analizzare anche la
                    traccia audio del video. **Per usare questa opzione deve
                    essere abilitata nel tuo piano tariffario**.
                with_smart_analysis:
                  type: boolean
                  description: >-
                    Impostalo a true per attivare la **Smart Full Analysis** su
                    ogni frame analizzato: un algoritmo di scoring proprietario
                    seleziona le aree più informative del frame, che vengono
                    classificate come ritagli separati dal modello più avanzato
                    della famiglia Revelio e poi combinate in un verdetto
                    complessivo. Essendo una versione avanzata e smart di
                    entrambe, **sostituisce l'analisi completa standard e
                    l'analisi con heatmap dei frame**. **Per usarla deve essere
                    abilitata nel tuo piano tariffario**, altrimenti il
                    parametro viene ignorato. Consulta [Smart Full
                    Analysis](/it/classification/classify-video#smart-full-analysis)
                    per i dettagli.
                webhook_url:
                  type: string
                  description: >-
                    Se indicato, il risultato della classificazione viene
                    inviato automaticamente anche all'URL inserito. Altrimenti
                    il risultato si ottiene tramite polling dell'[endpoint
                    relativo](./get-classification-result-video). Tieni presente
                    che per usare un URL di callback del webhook **devi
                    richiedere un'abilitazione specifica**, altrimenti il
                    parametro viene ignorato. Inoltre il sistema può mettere in
                    cache i risultati delle analisi di invii ripetuti, cioè
                    invii dello stesso file con le stesse opzioni: in questo
                    caso il webhook non viene chiamato e i risultati sono
                    accessibili solo tramite polling dell'[endpoint
                    relativo](./get-classification-result-video).
                with_xai:
                  type: boolean
                  description: >-
                    Impostalo a true per attivare lo scope **XAI – eXplainable
                    AI**: oltre al verdetto, i modelli Revelio restituiscono
                    informazioni sulle aree di ogni frame analizzato su cui si
                    sono concentrati durante la classificazione (attention map e
                    attention graph). XAI viene applicato a ogni frame
                    analizzato. **Per usarlo deve essere abilitato nel tuo piano
                    tariffario**, altrimenti il parametro viene ignorato.
                    Consulta [XAI – eXplainable
                    AI](/it/classification/classify-video#xai-explainable-ai)
                    per i dettagli. **Avviso sul trasferimento dei dati:**
                    attivando questa funzionalità, i dati delle tue immagini
                    vengono trasferiti alla nostra infrastruttura cloud nell'UE
                    per l'inferenza dei modelli.
                with_llm_xai:
                  type: boolean
                  description: >-
                    Impostalo a true, insieme a `with_xai`, per ottenere anche
                    le **spiegazioni AI**: una descrizione in linguaggio
                    naturale delle regioni che hanno ricevuto più attenzione,
                    restituita nel campo `description` delle `explanations` dei
                    risultati per modello quando i [risultati
                    differiti](/it/api-reference/deferred-results) sono pronti.
                    Le spiegazioni vengono prodotte per ogni frame analizzato.
                    Viene ignorato se `with_xai` non è attivo. Se XAI è incluso
                    nel tuo piano tariffario ma le spiegazioni AI no, una
                    richiesta con `with_llm_xai=true` viene rifiutata con un
                    errore `403`. I crediti delle spiegazioni che non è
                    possibile generare vengono rimborsati. Le spiegazioni AI
                    sono generate con modelli non sviluppati da identifAI.
                llm_xai_language:
                  type: string
                  enum:
                    - english
                    - italian
                    - spanish
                    - german
                  description: >-
                    Lingua delle spiegazioni AI (senza distinzione tra maiuscole
                    e minuscole). Se omessa, viene usata la lingua predefinita
                    del tuo piano tariffario. Viene applicata solo insieme a
                    `with_llm_xai`; un valore non supportato viene rifiutato con
                    un errore `400`.
                deferred_webhook_url:
                  type: string
                  description: >-
                    Se indicato, l'URL viene notificato una sola volta quando i
                    **risultati differiti** dell'invio sono completi (ad es. le
                    spiegazioni testuali delle mappe XAI e della heatmap), dopo
                    i risultati principali inviati a `webhook_url`. La notifica
                    contiene l'evento `submission.deferred.completed`: consulta
                    [Risultati differiti](/it/api-reference/deferred-results)
                    per il payload. Valgono la stessa abilitazione, le stesse
                    restrizioni di dominio e la stessa autenticazione di
                    `webhook_url`. La consegna è *at least once*: deduplica per
                    `identifier`, e tieni presente che una notifica `expired`
                    può essere seguita da una seconda con l'esito reale, che la
                    sostituisce. Se omesso o vuoto, non viene inviata alcuna
                    notifica dei risultati differiti.
                no_cache:
                  type: boolean
                  description: >-
                    Impostalo a true per obbligare il sistema a rielaborare
                    l'immagine anche se è già stata inviata con le stesse
                    opzioni. Questo può comportare costi aggiuntivi.
                prevent_c2pa_forces:
                  type: boolean
                  description: >-
                    Se true, la firma C2PA non forza l'origine ad artificiale.
                    Se false o non definito, la firma C2PA forza l'origine ad
                    artificiale (comportamento attuale).
                with_nsfw:
                  type: boolean
                  description: >-
                    Impostalo a true se vuoi attivare anche il rilevamento dei
                    contenuti NSFW (Not Safe For Work).
                ensure_face_per_frame:
                  type: boolean
                  description: >-
                    **[Funzionalità del piano]** Impostalo a true per scegliere
                    la strategia di estrazione dei frame con **volti**: partendo
                    dal campionamento a intervalli regolari, il sistema cerca
                    nel video i frame che contengono almeno un volto, fino al
                    numero di frame da analizzare (`frames`). Usalo insieme
                    all'opzione `with_morphing` per rilevare possibili face swap
                    o morphing nel video. È un'alternativa alle altre strategie:
                    quando è attivo, `key_frames` e `key_frames_method` vengono
                    ignorati, mentre viene ignorato a sua volta quando è
                    presente `frames_timestamps`. La ricerca ha un limite di
                    tempo, quindi nei video in cui i volti sono rari o assenti
                    potrebbero essere analizzati meno frame: i frame non
                    analizzati vengono rimborsati al termine dell'analisi.
                    Questa opzione **può aumentare il tempo di elaborazione** e,
                    a seconda del tuo piano tariffario, il costo di ogni frame.
                    **Per usare questa opzione deve essere abilitata nel tuo
                    piano tariffario**, altrimenti il parametro viene ignorato.
                frames_timestamps:
                  type: string
                  example: 00:00:05.000,00:01:12.500
                  description: >-
                    **[Funzionalità del piano]** Momenti specifici del video da
                    analizzare. Elenco di timecode separati da virgole nel
                    formato `HH:MM:SS.mmm`, misurati dall'inizio del file (ad
                    es. `00:00:05.000,00:01:12.500`). Quando è presente, viene
                    estratto esattamente un frame per ogni momento indicato e le
                    altre strategie di estrazione dei frame vengono disattivate:
                    `frames`, `key_frames`, `key_frames_method` e
                    `ensure_face_per_frame` vengono ignorati. I momenti
                    duplicati vengono contati una sola volta. Puoi indicare fino
                    a **30** momenti se il tuo piano tariffario ti permette di
                    scegliere il numero di frame, altrimenti fino al numero di
                    frame predefinito (**10**). **Viene addebitato un frame per
                    ogni momento distinto.** I momenti oltre la fine del video
                    vengono saltati: se nessuno cade all'interno del video, la
                    classificazione termina con un errore. **Per usare questa
                    opzione deve essere abilitata nel tuo piano tariffario**,
                    altrimenti il parametro viene ignorato.
                audio_timestamps:
                  type: string
                  example: 00:00:05.000,00:01:12.500
                  description: >-
                    **[Funzionalità del piano]** Momenti specifici della traccia
                    audio del video da analizzare. Elenco di timecode separati
                    da virgole nel formato `HH:MM:SS.mmm`, misurati dall'inizio
                    del file (ad es. `00:00:05.000,00:01:12.500`). Si usa solo
                    insieme a `with_audio`. Quando è presente, invece di
                    suddividere l'audio in segmenti lungo tutta la sua durata,
                    il sistema analizza un breve segmento audio centrato su ogni
                    momento indicato; i momenti abbastanza vicini da cadere
                    nello stesso segmento vengono analizzati insieme in un unico
                    segmento. I momenti duplicati vengono contati una sola
                    volta. Puoi indicare fino a **30** momenti se il tuo piano
                    tariffario ti permette di scegliere il numero di segmenti
                    audio, altrimenti fino a **5**. **Viene addebitato un
                    segmento audio per ogni momento distinto**: i segmenti non
                    prodotti (momenti raggruppati, momenti oltre la fine
                    dell'audio) vengono rimborsati al termine dell'analisi. Se
                    nessun momento cade all'interno dell'audio, la
                    classificazione termina con un errore. **Per usare questa
                    opzione deve essere abilitata nel tuo piano tariffario**,
                    altrimenti il parametro viene ignorato.
              required:
                - video
            encoding:
              video:
                contentType: video/*
      responses:
        '200':
          description: >-
            L'identificativo della classificazione. Il formato dipende
            dall'header Accept.
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    example: >-
                      8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0
              example:
                identifier: >-
                  8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0
            text/plain:
              schema:
                type: string
                example: >-
                  8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0
              example: 8d64370a87b820cc1cf620338f5c898bab37439c9a405f32d9eaffc50c4f27b0
        '400':
          description: >-
            L'utente non ha crediti sufficienti per eseguire l'operazione, la
            richiesta contiene parametri errati o il media non ha superato i
            controlli di validazione.
          content:
            application/json:
              examples:
                invalid_llm_xai_language:
                  summary: Lingua delle spiegazioni AI non supportata
                  value:
                    error:
                      llm_xai_language:
                        - The selected llm xai language is invalid.
                invalid_timestamps:
                  summary: Timestamp non validi
                  value:
                    error:
                      frames_timestamps:
                        - >-
                          The frames timestamps must be a comma-separated list
                          of timecodes in HH:MM:SS.mmm format.
                validation_error:
                  summary: Esempio di errore di validazione
                  value:
                    video:
                      - The video field is required.
                unsupported_format:
                  summary: Formato di file non supportato
                  value:
                    error: The uploaded file format is not supported.
                file_too_large:
                  summary: File troppo grande
                  value:
                    error: The uploaded file exceeds the maximum allowed size of 5GB.
        '401':
          description: API key non valida o mancante.
          content:
            application/json:
              example:
                error: Unauthorized
        '403':
          description: >-
            L'utente non è autorizzato ad accedere a questa API o non ha
            accettato i Termini di servizio, oppure `with_llm_xai` è impostato
            su true ma le spiegazioni AI di XAI non sono incluse nel tuo piano.
          content:
            application/json:
              examples:
                forbidden:
                  summary: Accesso negato
                  value:
                    error: Forbidden
                llm_xai_not_enabled:
                  summary: Spiegazioni AI non abilitate
                  value:
                    error: >-
                      LLM explanations (with_llm_xai) are not enabled for your
                      plan
        '429':
          description: Troppe richieste.
          content:
            application/json:
              example:
                error: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: La tua API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.