Transcriptions

list_transcriptions

Client.list_transcriptions(recording_id, size=None, **kwargs)

Get a list of transcriptions

Parameters:
  • recording_id (str) – id of a recording
  • size (int) – Used for pagination to indicate the size of each page requested for querying a list of items. If no value is specified the default value is 25. (Maximum value 1000)
Return type:

types.GeneratorType
Returns:

list of transcriptions

Example: Print off all transcriptions for a recording:

transcriptions_list = api.list_transcriptions('recordingId')
print(list(transcriptions_list))
## [
##     {
##         'chargeable_duration': 60,
##         'id': '{transcription-id}',
##         'state': 'completed',
##         'time': '2014-10-09T12:09:16Z',
##         'text': '{transcription-text}',
##         'text_size': 3627,
##         'text_url': '{url-to-full-text}'
##     },
##     {
##         'chargeable_duration': 60,
##         'id': '{transcription-id}',
##         'state': 'completed',
##         'text': '{transcription-text}',
##         'time': '2014-10-09T14:04:44Z',
##         'text_size': 72,
##         'text_url': '{url-to-full-text}'
##     }
## ]

create_transcription

Client.create_transcription(recording_id)

Create a transcirption for given recording

Parameters:recording_id (str) – id of a recording
Return type:str
Returns:id of created transcription

Example: Create new transcription from existing recording:

transcription_id = api.create_transcirption('recordingId')

get_transcription

Client.get_transcription(recording_id, transcription_id)

Get information about a transcription

Parameters:
  • recording_id (str) – id of a recording
  • id (str) – id of a transcription
Return type:

dict
Returns:

application information

Example: Fetch a single transcription on a recording:

my_transcription = api.get_transcription('recordingId', 'transcriptionId')
print(my_transcription)
## {
##     'chargeable_duration': 11,
##     'id'                : '{transcriptionId}',
##     'state'             : 'completed',
##     'text'              : 'Hey there, I was calling to talk about plans for this saturday. ',
##     'text_size'          : 63,
##     'text_url'           : 'https://api.catapult.inetwork.com/.../media/{transcriptionId}',
##     'time'              : '2014-12-23T23:08:59Z'
## }