IMimentiv
Video Emotion API

Retrieve Domination Emotion For A Specific Frame

Changed on

This API endpoint is designed to fetch and return the dominant emotion of frames within a video based on its video_id. If face_id is provided, the dominant emotion of a specific face will be the output.

get/v1/videos/{video_id}/frames/{frame_id}/dominant_emotion

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

Unique identifier of the video from which the frame’s dominant emotion is to be fetched.

frame_idstring required

The unique id of the frame from which the dominant emotion is to be fetched.

Query parameters

face_idstring nullable

The id of the face whose dominant emotion is to be retrieved. If not provided, the dominant emotion for the entire frame will be returned.

Response

Successful Response

frame_idstring required
face_idinteger nullable
dominant_emotionstring nullable
messagestring nullable

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