Skip to navigation
API ReferenceBatch Transcribe

Get Batch Transcription By Client Item ID

Resolve a batch item’s client_item_id to the resulting transcription.

client_item_id values are unique only within a batch, so this lookup is scoped by batch_id.

The response is a standard TranscriptionInfo object. Its id field is the canonical transcription ID for the batch item.

Authentication

AuthorizationBearer

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

Path parameters

batch_idUUIDRequired

The batch ID returned from Create Batch Transcription

Query parameters

client_item_idstringRequired

The caller-defined client_item_id to resolve within this batch.

Response

This endpoint returns an object.
idUUID
ID of the transcription
titlestring
Title of the transcription
created_atdatetime
When the transcription was created
statusenum
Current status of the transcription
client_item_idstringOptional

Caller-defined per-item identifier for batch items. This is null for single transcriptions and for batch items submitted without a client_item_id.

folder_idUUIDOptional
Containing document folder, or null for root.
primary_languageenumOptional
The primary language of the audio content. This is null when an upload has not yet been configured for transcription.
Allowed values:
hebrew_word_formatlist of enumsOptional

Indicates how Hebrew words are transcribed in the response when the primary language is English.

  • hybrid uses italicized English transliteration for short phrases and Hebrew letters for longer phrases.
  • Hebrew words are in Hebrew letters if “he” is specified.
  • Hebrew words are transliterated into English letters if “en” is specified.
  • If both “he” and “en” are specified, both versions are provided back-to-back for each Hebrew word. Transliterated Hebrew words are surrounded by <i> tags in the response text. This is null when no Hebrew-word format has been configured for the upload.
Allowed values:
num_speakersintegerOptional

Number of speakers in the audio. This can be null while auto-detection is pending or if no count was determined.

durationdoubleOptional
Duration of the audio in seconds. If None, it means the duration was not calculated yet.
modelstringOptional
Model used for the transcription. V1 is the latest and most accurate model, especially for audio with longer stretches of Hebrew. V0 is suitable for audio with fewer Hebrew words.

Errors

401
Authentication Error
404
Batch Item Not Found
404
Batch Not Found
429
Rate Limit Error