Get speaker analysis

GET

/v2/transcriptions/:id/speaker-analysis

GET

/v2/transcriptions/:id/speaker-analysis

curl https://api.sync.so/v2/transcriptions/6533643b-aceb-4c40-967e-d9ba9baac39e/speaker-analysis \
     -H "x-api-key: <apiKey>"

{
  "revision": "3f9a1c0e7b2d4a6f8e1c3b5d7f9a0c2e4b6d8f0a1c3e5b7d9f1a3c5e7b9d0f2a",
  "sourceStartMs": 0,
  "status": "completed",
  "speakers": [
    {
      "id": "speaker_0",
      "status": "matched",
      "avatar": {
        "sourceTimeMs": 4200,
        "box": {
          "x": 0.18,
          "y": 0.22,
          "width": 0.14,
          "height": 0.25
        },
        "sourceWidth": 1920,
        "sourceHeight": 1080
      },
      "faceTrack": {
        "url": "https://assets.sync.so/docs/example-face-track.json",
        "fps": 25,
        "frameCount": 750,
        "sourceWidth": 1920,
        "sourceHeight": 1080
      }
    },
    {
      "id": "speaker_1",
      "status": "uncertain",
      "reason": "insufficient_support"
    }
  ],
  "sourceVideoUrl": "https://assets.sync.so/docs/example-video.mp4",
  "sourceEndMs": 30000
}

Returns which face belongs to each transcript speaker. Each speaker is matched, with an avatar, evidence and a face track, or uncertain, with a reason. Analysis may already be available for video transcriptions of your own media. Read this endpoint before starting an analysis. Poll while status is processing, until it is completed or unavailable. Requires a completed transcription.

Authentification

x-api-keystring

Authentification par clé API via en-tête

Paramètres de chemin

idstringRequis

Transcription job id.

Réponse

Speaker analysis retrieved successfully

revisionstring

The transcription revision this analysis belongs to.

sourceStartMsinteger

Start of the analyzed window, in source milliseconds.

statusenum

Status of the speaker analysis. processing is not terminal; completed and unavailable are.

Valeurs autorisées:

speakerslist of objects

One entry per transcript speaker, up to 8.

sourceVideoUrlstringOptionnel

The analyzed source video. Null for jobs created from sourceAudioUrl.

sourcePlaybackUrlstringOptionnel

A temporary URL for playing the source video.

sourceEndMsintegerOptionnel

End of the analyzed window, in source milliseconds. Null when the window runs to the end of the source.

reasonstringOptionnel

Why the analysis is unavailable or wasn't run.

modelstringOptionnel

The model that ran the analysis.

Erreurs

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error