Get Transcript

Get the transcript file for a job. The job must have completed transcription before a transcript can be downloaded.

HTTP Method

GET /api/job/get_transcript

Query String Parameters — Required

Name	Details
v	Description	The version of the API to use
	Allowed Values	1
	Example	v=1
api_token	Description	The API token used for this session
	Allowed Values	Hex String
	Example	api_token=7ca5dc5c7cce449fb0fff719307e8f5f
job_id	Description	The ID of the job
	Allowed Values	Hex String
	Example	job_id=64bea283eff6475ea6596027a6ba0929

Query String Parameters — Optional

Name	Details
create_paragraphs	Enable or disable paragraph breaks. If disabled, the text will only be broken up by the timecode_interval or newlines_after_sentence options.
	Allowed Values	Boolean
	Default Value	true
	Example	create_paragraphs=true
audio_description	Select Audio Description Transcript
	Allowed Values	Boolean
	Default Value	false
	Example	audio_description=true
mixed	**Requires audio_description parameter** Mixes together the audio description transcript into the caption transcript
	Allowed Values	Boolean
	Default Value	false
	Example	mixed=true
elementlist_version	The version of element list to generate the transcript from. If not specified, the transcript will be generated from the latest version.
	Allowed Values	ISO 8601 Date String
	Default Value	“”
	Example	elementlist_version=2014-07-31T12:35:52Z
iwp_name	The named version of element list to generate the transcript from. If not specified, the transcript will be generated from the latest version.
	Allowed Values	String
	Default Value	“”
	Example	iwp_name=MECHANICAL
emit_speaker_change_tokens_as	Determine what characters to use to denote speaker changes.
	Allowed Values	String
	Default Value	“>>”
	Example	emit_speaker_change_tokens_as=--
newlines_after_paragraph	If generating paragraphs, insert the specified number of new lines after each paragraph.
	Allowed Values	Integer
	Default Value	2
	Example	newlines_after_paragraph=3
newlines_after_sentence	Insert the specified number of new lines after each sentence.
	Allowed Values	Integer
	Default Value	0
	Example	newlines_after_sentence=1
remove_disfluencies	Remove verbal disfluencies from the generated transcript. Common disfluencies such as "um" and "ah" are removed while maintaining appropriate punctuation.
	Allowed Values	Boolean
	Default Value	true
	Example	remove_disfluencies=false
mask_profanity	Replace profanity with asterisks.
	Allowed Values	Boolean
	Default Value	false
	Example	mask_profanity=true
remove_sounds_list	A list of sounds to not show in the transcript. This is a JSON style list, and should look like ["MUSIC", "LAUGH"]. Ignored if remove_sound_references is true.
	Allowed Values	Sound Tag Enumeration
	Default Value	[]
	Example	remove_sounds_list=["MUSIC","LAUGH"]
remove_sound_references	Remove non-verbal sound and noise references from the generated transcript. Sounds and unidentified noises are depicted in the transcript as [SOUND], [COUGH] and [NOISE]. If this parameter is set, these identifiers are omitted from the transcript.
	Allowed Values	Boolean
	Default Value	true
	Example	remove_sound_references=false
replace_slang	Replace common slang terms from the generated transcript. Common replacements are "want to" for "wanna", "going to" for "gonna", etc.
	Allowed Values	Boolean
	Default Value	false
	Example	replace_slang=true
sound_boundaries	Specifies the characters to surround sound references with. The default will generate sound references that look like this: [MUSIC].
	Allowed Values	Character Tuple
	Default Value	(‘[‘,’]’)
	Example	sound_boundaries=('{','}')
timecode_every_paragraph	If generating paragraphs, include timecodes at the start of each one.
	Allowed Values	Boolean
	Default Value	true
	Example	timecode_every_paragraph=false
timecode_format	Time format string, supports: %H: hours, %M: minutes, %S: seconds, %f: milliseconds.
	Allowed Values	String
	Default Value	[%H:%M:%S.%f]
	Example	timecode_format=[%H:%M:%S]
timecode_interval	If generating timecodes, specify the interval in milliseconds.
	Allowed Values	Integer
	Default Value	0
	Example	timecode_interval=100
timecode_offset	Offset the start of the timecode by the given value in milliseconds.
	Allowed Values	Integer
	Default Value	0
	Example	timecode_offset=200
file_format	Select output file format
	Allowed Values	String. One of [txt, html, pdf (coming soon)]
	Default Value	txt
	Example	file_format=html
replace_english_spelling	Replaces English spelling with location accurate spelling i.e. Color --> Colour
	Allowed Values	String
	Default Value	A --> American B --> British Z --> British ize U --> Australian C --> Canadian
	Example	replace_english_spelling=B

Responses

HTTP Code	Details
200	Description	Success
	Contents	Transcript file as body data
400	Description	An error occurred
	Contents	Error description (see Error Format for details)

Example Requests

GET /api/job/get_transcript?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&job_id=64bea283eff6475ea6596027a6ba0929 HTTP/1.1
Host: api.cielo24.com

Example Response

HTTP/1.1 200 OK
Content-Type: text/plain

[00:00:01]
First line of text.

[00:00:11]
Second line of text.