3Play Media: Docs

APIv3: Quick Start

On this page, VARIABLE is used to indicate a value that should be substituted, such as an API key or ID number. Note that all examples here use basic authentication; the calls are the same for signed authentication but you also need to add your signature and expiration params.

  • Test your api key 
    curl "https://api.3playmedia.com/v3/authenticate?api_key=KEY"

    Responds

    {"code":200,"data":{"status":"ok","access_type":"project"},"meta":{}}
  • Order transcription
    First, create a new media file with a source (requires Project level API access): 
    curl -X POST -F "source_file=@LOCAL_FILE_PATH" "https://api.3playmedia.com/v3/files?api_key=KEY&language_id=1&name=NAME"

    Note: instead of providing source_file, you can provide the parameter source_url, pointing to a publicly downloadable media file source.

    Note: It is not required to provide a source_file or source_url at media file creation time. For some orders, (e.g. caption import) sources are not needed at all.

    Responds

    {"code":200,"data":{"id":FILE_ID,"name":"demo","language_id":1,"language_ids":[1],"source":null,"batch_id":{BATCH_ID},"reference_id":null},"meta":{}}
    Next, order your transcript (requires Project level API access): 
    curl -X POST "https://api.3playmedia.com/v3/transcripts/order/transcription?api_key=KEY&media_file_id=FILE_ID&turnaround_level_id=1"

    Responds

    {"code":200,"data":{"id":TRANSCRIPT_ID,"media_file_id":FILE_ID,"default":true,"type":"TranscribedTranscript","language_id":1,"language_ids":[1],"status":"in_progress"},"meta":{}}
  • Check the status of your transcript (requires Project or Observer level API access) 
    curl "https://api.3playmedia.com/v3/transcripts/TRANSCRIPT_ID?api_key=KEY"

    Responds

    {"code":200,"data":{"id":TRANSCRIPT_ID?,"media_file_id":FILE_ID?,"default":true,"type":"TranscribedTranscript","language_id":1,"language_ids":[1],"status":"in_progress"},"meta":{}}
  • Download your transcript when it is ready (requires Project or Observer level API access) 
    curl "https://api.3playmedia.com/v3/transcripts/TRANSCRIPT_ID/text?api_key=KEY&output_format_id=7"

    For a full list of available output format ids, issue a GET request to https://api.3playmedia.com/v3/transcripts/output_formats