get
https://api.neuronsinc.com/predict/v2/mixed-media//aois/status
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request params
| Field | Type | Required | Description |
|---|---|---|---|
media_id | string (UUID) | Yes | Path parameter. Identifier of the mixed media object. |
No request body is required.
Response 200 OK
200 OK| Field | Type | Description |
|---|---|---|
aoi_status | string | Current AOI detection status for the asset. |
Possible aoi_status values:
| Value | Description |
|---|---|
unspecified | No AOI detection has been configured or started. |
specified | AOIs have been defined manually but automatic detection has not run. |
started | AOI detection is in progress. |
done | AOI detection completed successfully. |
failed | AOI detection failed. |
Other responses
| Status | Description |
|---|---|
| 400 Bad Request | The 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
- Start AOI detection — Detect Mixed Media AOIs.
- Poll AOI status —
GET /predict/v2/mixed-media/{media_id}/aois/status(this endpoint) untilaoi_statusisdoneorfailed. - When
aoi_statusisdone, fetch AOI results fromGET /predict/v2/media/{media_id}or define custom AOIs viaPUT /predict/v2/mixed-media/{media_id}/aois.
