Get Transcription | SoferAi

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 filter the response to a single Hebrew word format. If set to 'en', the response text will have Hebrew characters removed and timestamps will exclude words tagged with 'he'. If set to 'he', italicized transliterations are removed from the text and timestamps will exclude words tagged only with 'en'. If set to 'hybrid', the response includes both transliteration and Hebrew characters for each word.

Response

This endpoint returns an object.

textstring

This field contains the transcription text. If the primary_language is English and only one hebrew_word_format is specified, the text will be in English with Hebrew words in the specified format. If multiple hebrew_word_format options are set, Hebrew words will appear in both formats, with the English transliteration in Italics. If the primary language is Hebrew, the text will be in Hebrew.

This field contains the transcription text. If the `primary_language` is English and only one `hebrew_word_format` is specified, the text will be in English with Hebrew words in the specified format. If multiple `hebrew_word_format` options are set, Hebrew words will appear in both formats, with the English transliteration in <i>Italics</i>. If the primary language is Hebrew, the text will be in Hebrew.

infoobject

Additional information about the transcription

timestampslist of objects or null

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

1	from soferai import SoferAI
2	from uuid import UUID
3
4	client = SoferAI(
5	api_key="YOUR_TOKEN_HERE"
6	)
7
8	client.transcribe.get_transcription(
9	transcription_id=UUID("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
10	)

1	{
2	"text": "Welcome to today's <i>shiur</i> שיעור. We will discuss the <i>halacha</i> הלכה regarding...",
3	"info": {
4	"id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"title": "My Shiur Transcription",
6	"created_at": "2024-01-15T09:30:00Z",
7	"primary_language": "en",
8	"hebrew_word_format": [
9	"en",
10	"he"
11	],
12	"num_speakers": 1,
13	"status": "COMPLETED",
14	"duration": 1802.5,
15	"model": "v1"
16	},
17	"timestamps": [
18	{
19	"word": "Welcome",
20	"start": 0,
21	"end": 0.5,
22	"hebrew_word_format": null,
23	"speaker": "1"
24	},
25	{
26	"word": "shiur",
27	"start": 2.1,
28	"end": 2.8,
29	"hebrew_word_format": [
30	"en"
31	],
32	"speaker": "1"
33	}
34	]
35	}

Authentication

Path parameters

Query parameters

Response

Errors