IMimentiv
Video Emotion API

Get Average Emotions

Changed on

Calculate and retrieve average emotion scores for a video with optional face filtering.

This endpoint computes the average emotion percentages across all frames in a video. When a face_id is provided, it calculates the average emotions for only that specific face.

Behavior:

  • Without face_id: Returns overall average emotion score for entire video (all faces combined)
  • With face_id: Calculates average emotion scores for the specified face

Parameters:

  • video_id: Unique identifier for the video
  • face_id: (Optional) Calculate average emotions for only this face ID

Response: Returns emotion scores as percentages (values sum to 1.0):

  • angry: Percentage of anger emotion
  • disgust: Percentage of disgust emotion
  • fear: Percentage of fear emotion
  • happy: Percentage of happiness emotion
  • sad: Percentage of sadness emotion
  • surprise: Percentage of surprise emotion
  • neutral: Percentage of neutral emotion

Use Cases:

  • Overall video analysis: Understand the general emotional tone of the entire video
  • Individual tracking: Track emotional patterns of specific people throughout the video
  • Comparative analysis: Compare emotional profiles between different faces in the same video

Example Usage:

  • Overall average: GET /v2/videos/123/emotions/average
  • Face-specific: GET /v2/videos/123/emotions/average?face_id=1

Note: Face-specific calculations require the face to appear in at least one frame.

get/v2/videos/{video_id}/emotions/average

Request

  • Base URL
    https://api.imentiv.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://api.imentiv.ai/oauth/authorize
      Token URL: https://api.imentiv.ai/oauth/token scopes: media.read

Path parameters

video_idstring required

The unique video ID of the video for which average emotions are to be calculated

Query parameters

face_idinteger nullable

Optional face ID to calculate average emotions for a specific face

Response

Successful Response

angrynumber

Score for angry

contemptnumber

Score for contempt

disgustnumber

Score for disgust

fearnumber

Score for fear

happynumber

Score for happy

neutralnumber

Score for neutral

sadnumber

Score for sad

surprisenumber

Score for surprise

Changes

  • 536bf48bb9fbRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security OAuth2Delegated was added to the API

  • 74ceee4a5c98Revision changes
    • info

      query request parameter face_id list-of-types was widened by adding types null

    • info

      for the query request parameter face_id, the type was generalized from integer to no type