Read a recording's check

For the /record page while the background check runs (x-recording-token header). status is analyzing until the check ends. A checked recording with no findings is then approved automatically, with every moment accepted. Otherwise it is needs_review: analyzed is false when no model could check it, and secret is true when a credential is on screen, which blocks approval.

get/api/recordings/{id}

Request

  • Base URL
    https://www.toma.com
  • URL
    https://www.toma.com/api/recordings/{id}
  • Auth
    none required

Path parameters

idstring required

Response

The recording's status and what the check found.

idstring
status'uploading' | 'analyzing' | 'needs_review' | 'approved' | 'failed'
analyzedboolean

False while analyzing, or when no model could check it.

findingsinteger

Things that may be private on screen or in the audio.

secretboolean

A credential is on screen; approval is refused.

momentsinteger

Moments that sound like requirements.

reviewobject nullable

What to review before approving: seconds, webcam, analyzed, summary, findings, moments, acceptedMoments, approved (as on DraftRecording). Null while analyzing.

Changes

No recorded changes to this operation across all 1 revision of this API.