WatchingWords API

Media

createMedia

Add media to your account

Post media you wish to add to your account for transcription. 


/media

Usage and SDK Samples

curl -X post "https://app.watchingwords.com/api/v1/media?url=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    public static void main(String[] args) {
        
        MediaApi apiInstance = new MediaApi();
        String url = url_example; // String | The url of the media you wish transcribed.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            Media result = apiInstance.createMedia(url, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#createMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String url = url_example; // String | The url of the media you wish transcribed.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            Media result = apiInstance.createMedia(url, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#createMedia");
            e.printStackTrace();
        }
    }
}
String *url = url_example; // The url of the media you wish transcribed.
String *apiKey = apiKey_example; // Required for authentication, on your settings page.

MediaApi *apiInstance = [[MediaApi alloc] init];

// Add media to your account
[apiInstance createMediaWith:url
    apiKey:apiKey
              completionHandler: ^(Media output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var WatchingWordsApi = require('watching_words_api');

var api = new WatchingWordsApi.MediaApi()

var url = url_example; // {String} The url of the media you wish transcribed.

var apiKey = apiKey_example; // {String} Required for authentication, on your settings page.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createMedia(url, apiKey, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createMediaExample
    {
        public void main()
        {
            
            var apiInstance = new MediaApi();
            var url = url_example;  // String | The url of the media you wish transcribed.
            var apiKey = apiKey_example;  // String | Required for authentication, on your settings page.

            try
            {
                // Add media to your account
                Media result = apiInstance.createMedia(url, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.createMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MediaApi();
$url = url_example; // String | The url of the media you wish transcribed.
$apiKey = apiKey_example; // String | Required for authentication, on your settings page.

try {
    $result = $api_instance->createMedia($url, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->createMedia: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Query parameters
Name Description
url*
apiKey*

Responses

Status: 200 - A media object

Status: 0 - Unexpected error

getMedia

Get details for a file in your account

Get details for this media object. 


/media/{media_id}

Usage and SDK Samples

curl -X get "https://app.watchingwords.com/api/v1/media/{media_id}?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    public static void main(String[] args) {
        
        MediaApi apiInstance = new MediaApi();
        String mediaId = mediaId_example; // String | The id of the object you want status for.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            Media result = apiInstance.getMedia(mediaId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMedia");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String mediaId = mediaId_example; // String | The id of the object you want status for.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            Media result = apiInstance.getMedia(mediaId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMedia");
            e.printStackTrace();
        }
    }
}
String *mediaId = mediaId_example; // The id of the object you want status for.
String *apiKey = apiKey_example; // Required for authentication, on your settings page.

MediaApi *apiInstance = [[MediaApi alloc] init];

// Get details for a file in your account
[apiInstance getMediaWith:mediaId
    apiKey:apiKey
              completionHandler: ^(Media output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var WatchingWordsApi = require('watching_words_api');

var api = new WatchingWordsApi.MediaApi()

var mediaId = mediaId_example; // {String} The id of the object you want status for.

var apiKey = apiKey_example; // {String} Required for authentication, on your settings page.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMedia(mediaId, apiKey, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaExample
    {
        public void main()
        {
            
            var apiInstance = new MediaApi();
            var mediaId = mediaId_example;  // String | The id of the object you want status for.
            var apiKey = apiKey_example;  // String | Required for authentication, on your settings page.

            try
            {
                // Get details for a file in your account
                Media result = apiInstance.getMedia(mediaId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMedia: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MediaApi();
$mediaId = mediaId_example; // String | The id of the object you want status for.
$apiKey = apiKey_example; // String | Required for authentication, on your settings page.

try {
    $result = $api_instance->getMedia($mediaId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getMedia: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
mediaId*
Query parameters
Name Description
apiKey*

Responses

Status: 200 - A media object

Status: 0 - Unexpected error

getMediaTranscript

Get transcript for this media object

Get transcript for this media object.


/media/{media_id}/transcript.{format}

Usage and SDK Samples

curl -X get "https://app.watchingwords.com/api/v1/media/{media_id}/transcript.{format}?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MediaApi;

import java.io.File;
import java.util.*;

public class MediaApiExample {

    public static void main(String[] args) {
        
        MediaApi apiInstance = new MediaApi();
        String mediaId = mediaId_example; // String | The id of the object you want the transcript for.
        String format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaTranscript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MediaApi;

public class MediaApiExample {

    public static void main(String[] args) {
        MediaApi apiInstance = new MediaApi();
        String mediaId = mediaId_example; // String | The id of the object you want the transcript for.
        String format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MediaApi#getMediaTranscript");
            e.printStackTrace();
        }
    }
}
String *mediaId = mediaId_example; // The id of the object you want the transcript for.
String *format = format_example; // The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
String *apiKey = apiKey_example; // Required for authentication, on your settings page.

MediaApi *apiInstance = [[MediaApi alloc] init];

// Get transcript for this media object
[apiInstance getMediaTranscriptWith:mediaId
    format:format
    apiKey:apiKey
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var WatchingWordsApi = require('watching_words_api');

var api = new WatchingWordsApi.MediaApi()

var mediaId = mediaId_example; // {String} The id of the object you want the transcript for.

var format = format_example; // {String} The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.

var apiKey = apiKey_example; // {String} Required for authentication, on your settings page.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediaTranscript(mediaId, format, apiKey, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaTranscriptExample
    {
        public void main()
        {
            
            var apiInstance = new MediaApi();
            var mediaId = mediaId_example;  // String | The id of the object you want the transcript for.
            var format = format_example;  // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
            var apiKey = apiKey_example;  // String | Required for authentication, on your settings page.

            try
            {
                // Get transcript for this media object
                File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MediaApi.getMediaTranscript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MediaApi();
$mediaId = mediaId_example; // String | The id of the object you want the transcript for.
$format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
$apiKey = apiKey_example; // String | Required for authentication, on your settings page.

try {
    $result = $api_instance->getMediaTranscript($mediaId, $format, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MediaApi->getMediaTranscript: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
mediaId*
format*
Query parameters
Name Description
apiKey*

Responses

Status: 200 - A transcript of type: srt, vtt, dfxp, text, rtf, or html

Status: 0 - Unexpected error

Transcript

getMediaTranscript

Get transcript for this media object

Get transcript for this media object.


/media/{media_id}/transcript.{format}

Usage and SDK Samples

curl -X get "https://app.watchingwords.com/api/v1/media/{media_id}/transcript.{format}?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TranscriptApi;

import java.io.File;
import java.util.*;

public class TranscriptApiExample {

    public static void main(String[] args) {
        
        TranscriptApi apiInstance = new TranscriptApi();
        String mediaId = mediaId_example; // String | The id of the object you want the transcript for.
        String format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscriptApi#getMediaTranscript");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TranscriptApi;

public class TranscriptApiExample {

    public static void main(String[] args) {
        TranscriptApi apiInstance = new TranscriptApi();
        String mediaId = mediaId_example; // String | The id of the object you want the transcript for.
        String format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
        String apiKey = apiKey_example; // String | Required for authentication, on your settings page.
        try {
            File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TranscriptApi#getMediaTranscript");
            e.printStackTrace();
        }
    }
}
String *mediaId = mediaId_example; // The id of the object you want the transcript for.
String *format = format_example; // The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
String *apiKey = apiKey_example; // Required for authentication, on your settings page.

TranscriptApi *apiInstance = [[TranscriptApi alloc] init];

// Get transcript for this media object
[apiInstance getMediaTranscriptWith:mediaId
    format:format
    apiKey:apiKey
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var WatchingWordsApi = require('watching_words_api');

var api = new WatchingWordsApi.TranscriptApi()

var mediaId = mediaId_example; // {String} The id of the object you want the transcript for.

var format = format_example; // {String} The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.

var apiKey = apiKey_example; // {String} Required for authentication, on your settings page.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMediaTranscript(mediaId, format, apiKey, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMediaTranscriptExample
    {
        public void main()
        {
            
            var apiInstance = new TranscriptApi();
            var mediaId = mediaId_example;  // String | The id of the object you want the transcript for.
            var format = format_example;  // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
            var apiKey = apiKey_example;  // String | Required for authentication, on your settings page.

            try
            {
                // Get transcript for this media object
                File result = apiInstance.getMediaTranscript(mediaId, format, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TranscriptApi.getMediaTranscript: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TranscriptApi();
$mediaId = mediaId_example; // String | The id of the object you want the transcript for.
$format = format_example; // String | The format of the transcript returned: srt, vtt, dfxp, text, rtf, or html.
$apiKey = apiKey_example; // String | Required for authentication, on your settings page.

try {
    $result = $api_instance->getMediaTranscript($mediaId, $format, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TranscriptApi->getMediaTranscript: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Path parameters
Name Description
mediaId*
format*
Query parameters
Name Description
apiKey*

Responses

Status: 200 - A transcript of type: srt, vtt, dfxp, text, rtf, or html

Status: 0 - Unexpected error