> ## 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.

# Override video classification

> Submit an override for a video classification. The hash parameter uniquely identifies the submitted video file. If the same video (so the same hash) is uploaded multiple times, the override will be applied to all submissions that share this hash.



## OpenAPI

````yaml post /api/classification_video/{hash}/override
openapi: 3.0.0
info:
  title: identifAI API
  version: 1.0.0
  description: >-
    API for integrating identifAI's image and video classification
    capabilities.<br><details><summary>**How to obtain your API
    Key**</summary>To obtain your API key, follow these simple steps:  
    <ol><li><p>**Create a user profile and log in to the platform**</p>If you
    don't have an account yet, visit our platform and create a user profile.
    Once you've completed registration and verified your email, log in with your
    credentials.</li><li><p>**Access the user menu**</p>After logging in, click
    on your name or the user icon in the top-right corner of the
    screen.</li><li><p>**Select the API Key option**</p>In the dropdown menu
    that appears, select the "API Key" option. From there, you can view or
    generate your API key.</li></ol>Now you are ready to use your API key in our
    API!</details><details><summary>**How to use the API**</summary>To use the
    API, first make a **POST** request to start the classification. Then, use
    the provided ***identifier*** from the **POST** request to retrieve the
    results.

    <details>

    <summary>**1. Image Classification**</summary>
      * To classify an image, you need to make a **POST** request to `/api/classification` with the required parameters (for details on the parameters, refer to the *"Classification"* section below).
      * In the response, you will receive the ***identifier*** of the classified image.
      * Use the provided ***identifier*** to retrieve the classification results by making a **GET** request to `/api/classification/{identifier}` (for details on how to structure this request, see the *"Classification"* section below).
      * The response will contain the classification results for the image in JSON format.<br>In the response, you will find a ***results*** array, which includes the classification results for each model used, and a ***verdicts*** array, which contains the results for each heuristic applied.<br>If the classification is not yet complete, continue sending the **GET** request until the result is available.</details><details><summary>**2. Video Classification**</summary>
        * To classify a video, you need to make a **POST** request to `/api/classification_video` with the required parameters (for details on the parameters, refer to the *"Classification"* section below).
        * In the response, you will receive the ***identifier*** of the classified video.
        * Use the provided ***identifier*** to retrieve the classification results by making a **GET** request to `/api/classification_video/{identifier}` (for details on how to structure this request, see the *"Classification"* section below).
        * The response will provide the classification results for the video in JSON format. For video classification, the video is divided into *frames*.<br> In the response, you will find a ***results*** array that includes the classification outcomes for each model applied to each analyzed frame, and a ***verdicts*** array containing the results for each heuristic used.<br> If the classification is not complete, continue sending the **GET** request until the final results are returned.</details><details><summary>**3. All Classifications**</summary>The `/api/classifications` endpoint will return all the image classifications made by a user. This will list the results of all past image classification requests.</details><details><summary>**4. User Management**</summary>  The **POST** `/api/user` endpoint allows you to create a user, while the **DELETE** `/api/user` endpoint is used to delete a user (For the structure of the requests, see more in the user section below).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Classification routes
  - name: User
    description: User actions
  - name: Partner
    description: Partner actions
paths:
  /api/classification_video/{hash}/override:
    post:
      tags:
        - Classification
      summary: Override video classification
      description: >-
        Submit an override for a video classification. The hash parameter
        uniquely identifies the submitted video file. If the same video (so the
        same hash) is uploaded multiple times, the override will be applied to
        all submissions that share this hash.
      parameters:
        - name: hash
          in: path
          required: true
          schema:
            type: string
          description: The hash of the video.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                classification:
                  type: string
                  enum:
                    - human
                    - artificial
                  description: The correct classification.
              required:
                - classification
      responses:
        '201':
          description: Override created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  classification:
                    type: string
                    enum:
                      - human
                      - artificial
                    description: The override classification.
                  type:
                    type: string
                    enum:
                      - video
                    description: The type of content.
                  hash:
                    type: string
                    description: The hash of the video.
                required:
                  - classification
                  - type
                  - hash
              example:
                classification: artificial
                type: video
                hash: >-
                  1122bc922b7381529013a2198b9143c0b6a52669fd511cfb030418209f1751a6
        '400':
          description: >-
            Override already submitted, no request associated with this hash,
            content not classified yet, override no longer accepted, no
            completed request for this video, or validation errors.
          content:
            application/json:
              examples:
                validation_required:
                  summary: Classification field required
                  value:
                    classification:
                      - The classification field is required.
                validation_invalid:
                  summary: Invalid classification value
                  value:
                    classification:
                      - The selected classification is invalid.
                no_request:
                  summary: No request associated with this hash
                  value:
                    error: You haven't got any request for this content.
                already_submitted:
                  summary: Override already submitted
                  value:
                    error: You have already submitted a report for this content.
                not_classified:
                  summary: Content not classified yet
                  value:
                    error: This video was not classified yet.
                no_longer_possible:
                  summary: Override no longer accepted
                  value:
                    error: Is no longer possible to send a report for this video.
                no_completed_request:
                  summary: No completed request for this video
                  value:
                    error: No completed request for this video exists.
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              example:
                error: Unauthorized
        '403':
          description: >-
            The user is not authorized to access this API or did not accept the
            terms of service.
          content:
            application/json:
              example:
                error: Forbidden
        '429':
          description: Too many requests.
          content:
            application/json:
              example:
                message: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: Your API key.

````