Alignment: Upload Using the API

If you already have transcripts for your video/audio files, transcript alignment is a faster and less expensive way to create captions and/or use the 3Play Media interactive video plugins. Media files and pre-existing transcripts can also be submitted to 3Play Media for alignment using the API.

Transcription Alignment service

Before getting started you will need...

- A video/audio file

- A pre-existing transcript of the video/audio file in an unformatted plain text  (.TXT) format.

- Your API and secret API keys 

See information about 3Play Media's suggested best practices to achieve the highest quality results when using this service. 

Please note that the duration of each file submitted for alignment should not exceed 2 hours.
DO NOT submit songs, music etc. The alignment process is intended for speech not singing.


For users new to the transcript alignment process it is suggested to set up the alignment review tool before submitting transcript for alignment.


See more information on the transcript alignment review tool


Upload a new file for alignment




This method allows a link or full file to be posted to the 3Play Account system. As soon as the file reaches the system, it will begin processing.

To upload a link, specify your link in the link attribute. To upload a full file, attach the file as the file attribute.

In both cases, you can upload to a specific folder. If you know the system id for that folder, use the batch_id attribute.

Alternatively, you can upload to a specific folder with the batch_name attribute. If a folder with that name already exists, the file will go there. If it does not exist, it will be created for you.

If a folder is not specified, or the specified folder is not found, the upload will go into your last created folder. If you have no folders on file, the file will go into a new folder named "API Upload Folder".


Required Properties:

  • apikey
  • api_secret_key
  • link or file
  • for_alignment=1


Available Properties:

  • name
  • video_id
  • attribute1
  • attribute2
  • attribute3
  • batch_id
  • batch_name
  • callback_url
  • transcript_for_alignment={all the text here}
  • language_id


Note that the transcript_for_alignment must be valid UTF-8 text.

A successful upload will return an integer value tied to the internal file_id for processing. If you do not receive this integer value, please check the error status, make necessary modifications to your POST, and try again.

The following values may be specified for the language_id parameter (default is 1):

  • 1 = English (generic)
  • 2 = US English
  • 3 = GB English
  • 4 = French (generic)
  • 5 = FR French
  • 6 = CA French
  • 7 = German
  • 8 = Dutch
  • 11 = Spanish (generic)
  • 12 = SP Spanish
  • 13 = LA Spanish
  • 14 = Portuguese (generic)
  • 15 = PT Portuguese
  • 16 = BR Portuguese
  • 49 = AU English
  • 50 = Catalan

Note: For English, we recommend using language_id=1, which is the default. 

Regarding Audio Description and Vertical Caption Placement 

Please note that Audio Description and Vertical Caption Placement can be ordered for alignment files once the transcription process is complete.

See more information regarding Audio Description

See more information regarding Vertical Caption Placement




Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk