The final result of the transcription - one of 'success' or 'failure'

A URI (currently restricted to http/https) which Scribe can send information to when the
transcription is complete.

When the URI protocol is http or https we will make a PUT request to the callback_uri to
indicate a change in the status of the transcription job.  The PUT request body will be
JSON and contain the transcription id and if the transcription completed successfully or not:
```json
{ 'transcription_id': '<ID>', 'result': 'success' }
```

A separate call can then be made to retrieve the transcript (or any failures while generating it).


Additional 'context' information that can be attached to the transcription.  This is typically never read
on the Kensho side, but it can be used to recall or cross-reference internal information about the
transcript.  A typical scenario could be one where transcriptions are submitted with titles, names and
tracked with internal IDs which is needed when retrieving the transcript.


a single or multiline block of text with 'context' on this transcription.


This is an array of up 1000 words to potentially use when determining the correct word spoken.
Leaving this value empty or null is the same as providing an empty list of words

**NOTE - Only applicable when `machine` is specified as the transcriber.**


The source language of the media.  If the media is not in english then the contents will have to be translated
prior to transcription.  This is a single, ISO-639, language code which can be two characters for ISO-639-1 (ie en)
or three characters for ISO-639-3 (ie zho).

**NOTE - Only applicable when `human` is specified as the transcriber.**


This is the priority of the transcription and is dictated by contractual turn around times.

**NOTE - Only applicable when `human` is specified as the transcriber.**


The type of transcription to perform - either machine only (AI) or human assisted (human in the loop).


A detailed statement about why the error occurred.

An error code which can be used to get more information about the problem.

The URL pointing to the media to transcribe.
This needs to be a full URL, less than 2048 characters, where Scribe can GET the data from without any other
intervention (credentials, tokens, etc.).
If Scribe cannot GET from that URL then the job will fail.


A structured output of the transcript - ideal for programmatic or custom uses of transcriptions

An indicator of accuracy - a higher number gives a higher confidence towards the transcription.


The binary data for the media to transcribe.
Along with the binary data you will want to provide the `filename` in the value for `Content-Disposition`,
and the mime type in the value for `Content-Type`.  The `Content-Type` currently can be one of:
- application/mp3
- audio/aac
- audio/flac
- audio/m4a
- audio/mp3
- audio/mpeg
- audio/mpeg3
- audio/wav
- audio/wave
- audio/x-flac
- audio/x-m4a
- audio/x-mpeg-3
- audio/x-wav
- video/mp4


An indicator of the accuracy of the transcribed slice - a higher number gives a higher confidence.


The duration of the slice in milliseconds

An indicator of the accuracy of the speaker identification - a higher number gives a higher confidence.


The ID of the speaker in the stream of audio.  Typically this increments from 0 (first detected speaker)
and, when negative (unknown speaker), indicates that we are not confident in saying we've heard this
speaker in the audio before.


The start time, from the beginning of the file, of the slice in milliseconds

An indicator of the accuracy of the transcribed token - a higher number gives a higher confidence.


Indicates whether the token has a definitive timestamp

The token start time, in milliseconds, from the beginning of the file.

A Kensho access token is required for all transcription requests.  For more information on access tokens,
and how to obtain them, view the [authentication guide](../../authentication).


Scribe's Batch API is a RESTful API allowing users to asynchronously transcribe audio or video files.


Scribe Batch API

If the request includes the `callback_uri` option then this endpoint will be called when the transcription is complete.
The endpoint must be externally accessible and any response other than 200 will be seen as failure.  A failure to call
the callback will not result in a failed transcription.


An optional callback invoked upon transcription completion.

Starts a transcription request for a single audio or video file.

We support a wide array of audio formats along with their respective compression / codec
options including:
 - AAC
 - FLAC
 - MP1
 - MP3
 - WAV

Currently we only support MP4 video files where the audio streams _must_ be one
of the supported audio formats.

Files must be less than or equal to 1 gigabyte in size, and the upload must
take less than 30 minutes.

Multichannel audio will be merged into a single stream prior to transcription.
In very rare cases this can cause transcription issues with stereo audio when
the two channels have near identical content that is slightly out of phase.


An invalid request was made to the server.

Authentication information was not provided - check to ensure that `Authorization`
header is present.


The transcript, for the `transcription_id`, cannot be found.


The request was rate limited.  Limit the requests to a maximum of 5 per second to avoid
getting this.


Attempts to ensure that all stored data for a transcription is no longer available on the system.

transcription_id

All stored data associated with the transcription is no longer available.
This could mean that:
 * The transcription data existed and is no longer available.
 * The transcription data did not exist and is still no longer available.
 * The transcription data was not available to you and so, as far as you are concerned, the data is no longer available.


Get the resulting transcript from the transcription request.

The date and time, after which, the transcription will no longer be retrievable

The transcription, with the `transcription_id` is still in progress.  Retrying
later will yield a successful result.


A transcription cannot be returned for the given 'Accept' mime type.


Determines if a transcript is available for download or not.

The transcription, for the `transcription_id` is complete and can be downloaded
for the returned `Content-Type`.


The transcription, for the `transcription_id` is still in progress.  Retrying
later will yield a successful result.


A transcription cannot be queried for the given 'Accept' mime type.


Batch API specification