Get Transcription | SoferAi

{
  "text": "Welcome to today's <i>shiur</i> שיעור. We will discuss the <i>halacha</i> הלכה regarding...",
  "info": {
    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "title": "My Shiur Transcription",
    "created_at": "2024-01-15T09:30:00Z",
    "primary_language": "en",
    "hebrew_word_format": [
      "en",
      "he"
    ],
    "status": "COMPLETED",
    "num_speakers": 1,
    "duration": 1802.5,
    "model": "v1"
  },
  "timestamps": [
    {
      "word": "Welcome",
      "start": 0,
      "end": 0.5,
      "hebrew_word_format": null,
      "speaker": "1"
    },
    {
      "word": "shiur",
      "start": 2.1,
      "end": 2.8,
      "hebrew_word_format": [
        "en"
      ],
      "speaker": "1"
    }
  ]
}

Get transcription

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

transcription_idUUIDRequired

ID of the transcription. Use the ID returned from the Create Transcription endpoint.

Query parameters

filter_hebrew_word_formatstringOptional

Optionally choose a Hebrew-word rendering for the response. If set to en, Hebrew characters are removed and timestamps exclude words tagged only with he. If set to he, italicized transliterations are removed and timestamps exclude words tagged only with en. If set to hybrid, the stored mixed rendering is returned without en/he filtering; it does not duplicate every Hebrew word in both formats.

Optionally choose a Hebrew-word rendering for the response. If set to `en`, Hebrew characters are removed and timestamps exclude words tagged only with `he`. If set to `he`, italicized transliterations are removed and timestamps exclude words tagged only with `en`. If set to `hybrid`, the stored mixed rendering is returned without `en`/`he` filtering; it does not duplicate every Hebrew word in both formats.

Response

This endpoint returns an object.

textstring

This field contains the transcription text. For English-primary audio, the default hybrid format uses italicized English transliteration for short Hebrew phrases and Hebrew letters for longer phrases. With only en or he, Hebrew words use that format. If both en and he are requested, Hebrew words appear in both formats with the English transliteration in italics. If the primary language is Hebrew, the text is in Hebrew. If the primary language is French, the text is in French with Hebrew, Yiddish, and Aramaic words in Hebrew letters.

infoobject

Additional information about the transcription

timestampslist of objectsOptional

Timestamps object for the transcription. See the timestamps object for more details.

Errors

401

Authentication Error

404

Transcription Not Found

429

Rate Limit Error