Detect Mixed Media Aois

Automatically detect potential AOIs in a mixed media asset

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request params

FieldTypeRequiredDescription
media_idstring (UUID)YesPath parameter. Identifier of the mixed media object.

No request body is required.

Response 202 Accepted

FieldTypeDescription
detailstringConfirmation message. Always "AOI detection started".

AOI detection runs asynchronously. Poll GET /predict/v2/mixed-media/{media_id}/aois/status until aoi_status is done or failed.

If detection is already in progress (aoi_status is started), the endpoint still returns 202 with the same message and does not start a duplicate job.

Other responses

StatusDescription
400 Bad RequestThe media exists but is not mixed media. Response body: {"detail": "Media is not mixed media"}.
404 Not FoundNo media with this media_id exists for your company.

Example request

POST /predict/v2/mixed-media/036d5cb3-4fb1-4e88-98e6-1854b607d296/aois/detect
X-API-Key: {your_api_key}

Example response

{
  "detail": "AOI detection started"
}

Typical workflow

  1. Create and predict mixed media — complete Create Mixed Media (or Create VAST Mixed Media) and Predict Mixed Media until prediction status is done.
  2. Detect AOIsPOST /predict/v2/mixed-media/{media_id}/aois/detect (this endpoint).
  3. Poll AOI statusGET /predict/v2/mixed-media/{media_id}/aois/status until aoi_status is done.
  4. Optionally update AOIs with custom regions via PUT /predict/v2/mixed-media/{media_id}/aois, or use detected AOIs from GET /predict/v2/media/{media_id}.
Path Params
string
required
Responses

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