Captions API Methods

IMPORTANT: If you want your API key to be encrypted please remember to use the HTTPS protocol!

 

Captions API Methods

Captions retrieved over the API are built from a core time-synchronized document. You can specify a number of parameters in your request to tailor the output to your needs.

 

Get Captions for File

 

[GET] http://static.3playmedia.com/files/:file_id/captions.:format?apikey=:api_key

Note that in this case, :file_id is the internal tracking ID for 3Play Media.

 

Get Captions by Video ID

[GET] http://static.3playmedia.com/files/:video_id/captions.:format?apikey=:api_key&usevideoid=1

Note that the :video_id references a user-uploaded ID, such as a video ID for a Brightcove, Ooyala, Kaltura, or YouTube video. If that ID is present, the appropriate caption files will be found for that record. Make sure you set usevideoid=1 in the URL params.

Available Formats: srt, dfxp, smi, stl, qt, qtxml, cptxml, adbe

Get Captions by threeplay_transcript_id

This is useful for getting captions for translations or captions imports.

GET api.3playmedia.com/files/:fileid/captions.srt?apikey=:apikey&threeplay_transcript_id=:threeplay_transcript_id 

 

 

 

Have more questions? Submit a request

4 Comments

  • 0
    Avatar
    Alex Britez

    Is it possible to call the API with a BrightCove video id? Like this? http://api.3playmedia.com/files/BRIGHTCOVE_VIDEO_ID/captions.dfxp?apikey=3PLAY_API_KEY . By the wording here.. "Note that the :video_id references a user-uploaded ID, such as a video ID for a Brightcove, Ooyala, Kaltura, or YouTube video. If that ID is present, the appropriate caption files will be found for that record."  makes it sounds like you could, but not having any luck.

  • 0
    Avatar
    David Zylber

    Hi Alex,

    Instead of http://api use http://static.3playmedia.com.  You also need to add the param "usevideoid=1" to the end of the URL. Feel free to submit a request with any other questions.  Check out the example below. Note: I removed http:// so it isn't truncated.

    Best,

    David

    [GET]static.3playmedia.com/files/:video_id/captions.:format?apikey=:api_key&usevideoid=1

  • 0
    Avatar
    Bryan Ollendyke

    This may be a silly question but docs seem to be conflicting; where can I find my :api_key?  Not seeing it in my user profile anywhere and searching for API only brings up this documentation.

  • 0
    Avatar
    Alex Britez

    @David, that worked like a charm, thanks. Silly mistake on my part.

    @Bryan, I found my under the "Collections" tab

Please sign in to leave a comment.
Powered by Zendesk