Mixed Media Aois Status

Return the current status of Mixed Media AOIs

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 200 OK

FieldTypeDescription
aoi_statusstringCurrent AOI detection status for the asset.

Possible aoi_status values:

ValueDescription
unspecifiedNo AOI detection has been configured or started.
specifiedAOIs have been defined manually but automatic detection has not run.
startedAOI detection is in progress.
doneAOI detection completed successfully.
failedAOI detection failed.

Other responses

StatusDescription
400 Bad RequestThe media does not exist for your company, or it is not mixed media. Response body: {"detail": "Media does not exist or is not mixed media"}.

Example request

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

Example response

{
  "aoi_status": "done"
}

Typical workflow

  1. Start AOI detectionDetect Mixed Media AOIs.
  2. Poll AOI statusGET /predict/v2/mixed-media/{media_id}/aois/status (this endpoint) until aoi_status is done or failed.
  3. When aoi_status is done, fetch AOI results from GET /predict/v2/media/{media_id} or define custom AOIs via PUT /predict/v2/mixed-media/{media_id}/aois.

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