Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (41 sloc) 3.42 KB

Sample Use Cases

Request from Media File Only

A job is created and a media file (audio or video) is submitted either via a URL or uploaded from the developer’s site. A task request is made of the job to perform transcription where task completion is determined via a callback URL or by the application’s polling of the interface to check on the status of the request. Once the requested transcription has been completed, all supported transcription and caption formats can be requested for this job.

The following delineates the simplified steps involved:

  1. Login via account credentials.

  2. Create job.

  3. Specify media file URL or upload the media file. A media file is either an audio or video file.

  4. Make request to perform a transcription task. Specify:

    1. :ref:`Fidelity <fidelity-label>` : MECHANICAL, PREMIUM or PROFESSIONAL fidelity transcription.
    2. :ref:`Priority <priority-label>` : STANDARD or PRIORITY.
  5. Wait for callback URL or poll task status for completion.

  6. [Option] Request transcript. Specify format of transcript (e.g. standard, time coded, replace slang, etc.). Request can be made multiple times for a given job (i.e. multiple requests can be made for multiple output types).

  7. [Option] Request caption file. Specify format of caption file (e.g. SRT, DFXP, lines per caption file, characters per caption line, etc.). Request can be made multiple times for a given job.

  8. [Option] Request complete element list. A complete list of all words and transcription codes is returned. In addition to the words, the following additional information is provided for each word: confidence score, starting time, ending time, preferred display format, and surrounding punctuation.

Request from Media File and Corresponding Transcript

A job is created and a media file (audio or video) is submitted either via a URL or uploaded from the developer’s site. In addition to the media file, a text transcript file is submitted either via a URL or uploaded from the developer’s site. A task request is made of the job to perform synchronization where task completion is determined via a callback URL or by the application’s polling of the interface to check on the status of the request. Once the requested synchronization has been completed, all supported transcription and caption formats can be requested for this job.

The following delineates the simplified steps involved:

  1. Login.
  2. Create job.
  3. Specify media file URL or upload the media file. A media file is either an audio or video file.
  4. Specify transcription file URL or upload the transcription file. Text file only.
  5. Request word synchronization (implies premium word timing), providing callback URL if desired.
  6. Wait for callback URL or poll task status for completion.
  7. [Option] Request transcript. See above description.
  8. [Option] Request caption file. See above description.
  9. [Option] Request complete element list. See above description.

Request from Existing Job

For any outstanding jobs, subsequent requests can be made for transcripts, caption files and element-lists, as delineated in the following steps:

  1. Specify job number.
  2. [Option] Request transcript. See above description.
  3. [Option] Request caption file. See above description.
  4. [Option] Request complete element list. See above description.