3Play Media: Docs

Transcripts

View and order services on your 3Play Media transcripts.

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer 3Play Media ID for transcript
media_file_id Integer ID of the media file the transcript belongs to
batch_id Integer ID of the batch the transcript belongs to
reference_id String Custom / Reference ID of the media_file the transcript belongs to
duration Float File duration, in seconds
default Boolean Whether the transcript is the default for its media file
type String The type of transcript (TranscribedTranscript, ImportedTranscript, etc.)
language_id Integer The 3Play Media language id for the transcript
language_ids Integer All languages associated with this transcript
status String The status of this transcript (in_progress, complete, or cancelled)
cancellable Boolean Whether or not the transcript order can be cancelled.
last_edited_by String Who last edited the transcript: '3Play Media', 'External Editor' or a specific customer name.
last_edited_at String When the transcript was last edited.
cancellation_reason String If status is 'cancelled', this field is included and contains a brief explanation.
cancellation_details String If status is 'cancelled', this field is included and may contain some details if available.

Note: The 'cancelled' status is used for orders that were either cancelled by the user or rejected by the 3Play system.

For Asr Transcripts the following fields will also be available:

Name Type Description
estimated_accuracy Integer An estimate of the automated accuracy
estimated_accuracy_threshold Float The configured accuracy threshold
accuracy_above_threshold Boolean True if the estimated_accuracy is greater than or equal to the estimated_accuracy_threshold

Note: For Transcription services, the Asr Transcript will only be available if progressive delivery is on.

For Alignment Transcripts the following fields will also be available:

Name Type Description
estimated_accuracy Integer An estimate of the automated accuracy
alignment_review_threshold Float The configured review threshold
accuracy_above_threshold Boolean True if the estimated_accuracy is greater than or equal to the alignment_review_threshold

View Actions

  • List transcripts in your project

    GET https://api.3playmedia.com/v3/transcripts/

    Parameter Type Description Required Default
    id Integer Filter by transcript id No no default
    media_file_id Integer Filter by a transcript's media_file_id No no default
    default Boolean Filter by a transcript's default status No no default
    status String Filter by transcript status: in_progress, complete, or cancelled No no default
    type String or Array<String> Filter by transcript type No no default
    language_id Integer Filter by transcript type No no default
    created_before Datetime Filter by transcripts created before specified date/time No no default
    created_after Datetime Filter by transcripts created after specified date/time No no default
    media_file_name String Filter by media file name No no default
    media_file_attribute1 String Filter by media file attribute1 No no default
    media_file_attribute2 String Filter by media file attribute2 No no default
    media_file_attribute3 String Filter by media file attribute3 No no default
    media_file_batch_id Integer Filter by media file batch_id No no default
    media_file_reference_id String Filter by media file reference_id No no default
    media_file_label String or Array<String> Filter by media file label(s) No no default
    media_file_created_before Datetime Filter by media file created_before No no default
    media_file_created_after Datetime Filter by media file created_after No no default
    media_file_archived Boolean Filter by media file archived No true
  • Show a specific transcript in your project

    GET https://api.3playmedia.com/v3/transcripts/:id

  • Get formatted text for a transcript (wrapped in default JSON structure)

    GET https://api.3playmedia.com/v3/transcripts/:id/text

    Parameter Type Description Required Default
    output_format_id Integer The id of the 3Play output format you wish to return the transcript in Yes no default
    clips[] String A pair of times, in milliseconds, representing the segment of the transcript you want. Multiple clips options may be sent (example clips[]=0,15000&clips[]=20000,30000). The returned transcript is trimmed and the times condensed to match just these segments No no default
    offset String The amount of time to offset a transcript. Specify 's' for seconds or 'ms' for milliseconds (example 30s or 30ms) No no default

    Note: PDF formats (e.g. output_format_id == 46) are not embedded in the JSON response 'data' field; they are directly downloaded in the response body. We recommend using the 'download' endpoint for PDF.

  • Download the transcript format directly

    GET https://api.3playmedia.com/v3/transcripts/:id/download

    Parameter Type Description Required Default
    output_format_id Integer The id of the 3Play output format you wish to return the transcript in Yes no default
    clips[] String A pair of times, in milliseconds, representing the segment of the transcript you want. Multiple clips options may be sent (example clips[]=0,15000&clips[]=20000,30000). The returned transcript is trimmed and the times condensed to match just these segments No no default
    offset String The amount of time to offset a transcript. Specify 's' for seconds or 'ms' for milliseconds (example 30s or 30ms) No no default

    Note: This endpoint does not wrap the response in a JSON structure; the response body is comprised entirely of the transcript data.

Order Actions

(Note: If a callback url is provided for any order, the payload sent to that URL will be the transcript object representation, in application/x-www-form-urlencoded format.)

  • Order a transcription service

    POST https://api.3playmedia.com/v3/transcripts/order/transcription

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order a transcription service for Yes no default
    turnaround_level_id Integer The id of the 3Play turnaround level you wish to order No 1
    callback String Callback URL for status updates No no default
  • Order an ASR only service

    POST https://api.3playmedia.com/v3/transcripts/order/asr

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order an ASR service for Yes no default
    callback String Callback URL for status updates No no default
  • Order an alignment service

    POST https://api.3playmedia.com/v3/transcripts/order/alignment

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order an Alignment service for Yes no default
    source_text_file File A transcript to be aligned to a media file (required if no source_text is present) Yes no default
    source_text String Text to be aligned to a media file (required if no source_text_file is present) Yes no default
    callback String Callback URL for status updates No no default
  • Order a video clip captioning service. Target file must have been assigned a parent media file (see files update and create)

    POST https://api.3playmedia.com/v3/transcripts/order/vicc

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order video clip captioning for Yes no default
    parent_media_file_id Integer The id of the 3Play Media file that acts as the video clip captioning parent for this media file Yes no default
    callback String Callback URL for status updates No no default
  • Order a translation service

    POST https://api.3playmedia.com/v3/transcripts/order/translation

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order a translation for Yes no default
    translation_service_option_id Integer The id of the 3Play Media translation service option you're requesting Yes no default
    source_transcript_id Integer An optional transcript id for this media file you wish to have translated (defaults to source transcript) No no default
    callback String Callback URL for status updates No no default
  • Order a caption import service

    POST https://api.3playmedia.com/v3/transcripts/order/import

    Parameter Type Description Required Default
    media_file_id Integer The id of the 3Play Media file you wish to order an import for Yes no default
    caption_file File The caption file to import Yes no default
    language_id Integer Language id of the imported caption file Yes no default
    autoparagraph Boolean Insert paragraph breaks automatically No false

    Note: The caption_file must be provided in a multipart post (e.g. using -F "caption_file=@LOCAL_FILE_PATH" in curl, or with header field "Content-Type: multipart/form-data" and the body payload conforming to RFC 2045) and must be a 3Play supported caption format.

  • Upgrade a transcript's turnaround level

    POST https://api.3playmedia.com/v3/transcripts/:id/upgrade_turnaround_level

    Parameter Type Description Required Default
    turnaround_level_id Integer The id of the 3Play turnaround level you wish to upgrade to Yes no default
  • Cancel a transcript

    POST https://api.3playmedia.com/v3/transcripts/:id/cancel

  • Retry a rejected transcript order

    POST https://api.3playmedia.com/v3/transcripts/:id/retry

    Note: The retry action may only be performed once on a transcript order. And, this is restricted to orders that were rejected by the 3Play system, not orders that were cancelled (even though the object state will be 'cancelled' in both circumstances.)

Transcript Actions

  • Make a transcript the default for its media file

    POST https://api.3playmedia.com/v3/transcripts/:id/make_default

  • Send an immediate callback to any registered callback URLs (see Delivery Routes)

    POST https://api.3playmedia.com/v3/transcripts/:id/callback

  • Redeliver a transcript

    POST https://api.3playmedia.com/v3/transcripts/:id/redeliver

  • Get an expiring editing link for a transcript

    GET https://api.3playmedia.com/v3/transcripts/:id/expiring_editing_link

    Parameter Type Description Required Default
    hours_until_expiration Integer How many hours the expring editing link is valid for Yes no default

Info actions

  • Info for various order routes

    GET https://api.3playmedia.com/v3/transcripts/order/transcription/help

    GET https://api.3playmedia.com/v3/transcripts/order/asr/help

    GET https://api.3playmedia.com/v3/transcripts/order/alignment/help

    GET https://api.3playmedia.com/v3/transcripts/order/vicc/help

    GET https://api.3playmedia.com/v3/transcripts/order/translation/help

    GET https://api.3playmedia.com/v3/transcripts/order/import/help

  • Get available transcription turnarounds for a media file

    GET https://api.3playmedia.com/v3/transcripts/order/transcription/turnarounds

    Parameter Type Description Required Default
    media_file_id Integer ID of the media file Yes no default
  • Get available output formats

    GET https://api.3playmedia.com/v3/transcripts/output_formats

    Name Type Description
    id Integer The output format's 3Play Media ID
    name String The name of the format
    type String The output format's type (Transcript/Caption)
    filetype String The file extension for the output format
    description String A brief description of the format
    advanced Boolean Whether the output format is a 3Play Media advanced format or not