Get Media Statuses
GET/v2/{media_type}/{media_id}/statuses
Get status fields for a specific media item, and the states to wait on.
Use query parameters to select which status fields to include. media_id, media_type and
the raw status are always returned. states describes each requested lifecycle field in one
vocabulary; it is {} when none was requested.
Waiting. Poll this route and stop when every field you care about has terminal: true.
terminal is true for completed, failed and skipped. Treat any state you do not
recognise as not finished: new states may be added. progress is a fraction from 0 to 1,
or null where none is reported. terminal describes the current operation only: a skipped
highlight becomes pending once you request one, so trigger before you wait. Use your own
deadline as well, and treat a 404 as "gone".
states values per field:
| Field | Possible states | Terminal | progress |
|---|---|---|---|
status | pending, processing, completed, failed | completed, failed | 1.0 when completed, otherwise the reported percentage, or null |
csv_status, pdf_status, summary_status | pending, processing, completed, failed | completed, failed | 1.0 when completed, otherwise null |
highlight_status | pending, processing, completed, failed, skipped (never requested) | completed, failed, skipped | 1.0 when completed, otherwise null |
annotated_video_status | pending, processing, completed, failed | completed, failed | 1.0 when completed, otherwise the reported percentage, or null |
personality_status | pending, processing, completed, failed, skipped (no audio) | completed, failed, skipped | 1.0 when completed, otherwise the reported percentage, or null |
frame_upload_status | pending, processing, completed, failed, skipped (frame upload is retired; no value was ever stored) | completed, failed, skipped | 1.0 when completed, otherwise the reported percentage, or null |
psychologist_review_status, speaker_face_match_status | pending, processing, completed, failed | completed, failed | 1.0 when completed, otherwise null |
face_deletion_status, speaker_deletion_status | pending, processing, completed, failed | completed, failed | 1.0 when completed, otherwise null |
A missing or unrecognised stored value is unknown and not terminal, except frame_upload_status: an absent value is skipped (frame upload is retired; see the table and the note below).
Not in states. share_status and speech_status are flags rather than progress, and the
percentage fields (process_status, frame_upload_progress, annotated_video_percentage,
personality_processing) are measurements that feed progress. The per-face
personality_statuses list is returned as before; inspect its entries yourself.
highlight_status reports pending in the raw field for a highlight that was never
requested, while states.highlight_status reports skipped. Likewise frame_upload_status
reports pending in the raw field when no value was ever stored (frame upload is retired, so
none will be), while states.frame_upload_status reports skipped.
Raw values (unchanged): completed, processing, pending, failed, plus no audio
for personality_status.
Auto-included Fields:
annotated_video_status→ also includesannotated_video_percentagepersonality_status→ also includespersonality_processingframe_upload_status→ also includesframe_upload_progresshighlight_status→ also includeshighlight_urlandhighlight_segments
Available Status Fields:
- General:
status,process_status,csv_status,pdf_status,summary_status,share_status - Video-specific:
highlight_status,annotated_video_status,personality_status,personality_statuses,frame_upload_status,face_deletion_status,speaker_face_match_status - Audio-related:
speech_status,speaker_deletion_status - Review:
psychologist_review_status
Request
Responses
- 200
- 422
Successful Response
Validation Error