Update Video Aois

Update AOIs for an existing video and return calculated metrics.

This endpoint differs from the POST /{media_id}/aois/static endpoint:

  • POST /{media_id}/aois/static starts a background static AOI calculation on the video. It queues the computation via VideoStaticAOIPrediction and returns HTTP 202 with a simple {"detail": ...} message once the job has been accepted. No AOI metrics are returned in that response.
  • PUT /{media_id}/aois performs a synchronous AOI calculation using the already available video results (video.results["saliency"]). It calls the external video_aoi_service and returns HTTP 200 together with the full calculation output.

Response:

  • On success, returns HTTP 200 with a body matching the VideoAOIsCalculationResponse schema, containing the calculated AOI results for the submitted AOIs and frame ranges, along with associated metadata.
  • On error, returns an appropriate HTTP status with a Detail payload.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
aois
array of objects
required
Aois*
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json