Transcription API Documentation (v4)

Introduction

Using this API you can submit files for:

  • transcription (audio/video files)
  • translation (documents/audio/video files)
  • captioning (audio/video files)
  • subtitling (audio/video files)

How it works?

workflow
  • 1. Your server sends url of a file you want to transcribe.
  • 2. When transcription is finished, GoTranscript will send url of transcription back to you.

When you will make an order, money will be deducted from your GoTranscript wallet.

When order will be finished, we will send POST request to your specified url.

Set your website url down below.

login to see form

Transcription Example

Send POST request to GoTranscript to order transcription.

<?php

$url = 'https://gotranscript.com/api/v4/transcriptions';
$data = [
    'mode' => 'test',
    'url' => 'https://gotranscript.com/tests/api/audio.mp3', // your file url
    'language' => 'english',
    'api_token' => 'login_to_see_token', // this is your API token
];
echo curlPost($url, $data); // function definition can be found at the bottom of documentation 
  • mode - When set to "test", file price is calculated but not charged from your wallet. This way you can test how much it will cost to make an order. When you want to make a real order, change "test" to "live".
  • url - file url you want to transcribe.
  • language - language of file. Values: english, french, spanish, italian, lithuanian, filipino, russian, polish, portuguese, dutch, german, turkish, croatian, arabic, chinese, japanese, greek, hebrew, finnish, hungarian, swedish, korean, estonian, indian, romanian, norwegian, malay, luxembourgish, danish, icelandic, nepali, ukraine
  • api_token - your api token.

You can pass additional parameters:

  • comment - Here you can specify names of speakers or other information for transcribers.
  • from - Start file transcription from this amount of seconds (integer).
  • till - Finish file transcription at this amount of seconds (integer).
  • text_format - values: clean_verbatim (default), full_verbatim
  • timestamping - values: not_required (default), every_2_minutes, change_of_speaker
  • turnaround_time - values: 1_days, 2_days, 3_days, 4_days, 5_days (default)
  • number_of_speakers - values: 1_or_2 (default), 3_or_more

Response will be in JSON format.

{
   "mode":"live",
   "status":"success",
   "order_id":123, // order_id will be set only when wallet is charged (live mode)
   "order_total":12.34 // $12.34 dollars
   "in_wallet":0, // how much money you have left in your GoTranscript wallet
} 

When file will be finished, POST request will be sent to your specified URL. It will contain this data:

{
    'mode' => 'live',
    'order_id' => 123,
    'transcription_url' => 'https://gotranscript.com/api/v4/test-file/1?api_token=login_to_see_token',
} 

When your server receives data, it must output ok. If it will not output ok, we will send this request again every hour up to 10 times.

Transcription file format. "'transcription_url" returns .docx document. You can also get plain text by adding to 'transcription_url' &format=text or get html by adding &format=html.
Example: https://gotranscript.com/api/v4/test-file/1?api_token=test&format=html. Works only in live mode.

To test how your server responds to request from gotranscript.com, click on link below.

Test transcription request to your server

Translation Example

Send POST request to GoTranscript to order translation.

<?php

$url = 'https://gotranscript.com/api/v4/translations';
$data = [
    'mode' => 'test',
    'url' => 'https://gotranscript.com/tests/api/audio.mp3', // your file url
    'translate_from' => 'english',
    'translate_to' => 'german',
    'api_token' => 'login_to_see_token', // this is your API token
];
echo curlPost($url, $data); // function definition can be found at the bottom of documentation 
  • mode - When set to "test", file price is calculated but not charged from your wallet. This way you can test how much it will cost to make an order. When you want to make a real order, change "test" to "live".
  • url - file url you want to transcribe.
  • translate_from - translate from language. Values: english, french, italian, spanish, lithuanian, romanian, portuguese, german, arabic, japanese, chinese, russian, dutch, danish, korean, norwegian, turkish, indian (hindi), indian (gujarati), filipino, polish, ukraine, greek
  • translate_to - translate to language. Values: english, french, italian, spanish, lithuanian, romanian, portuguese, german, arabic, japanese, chinese, russian, dutch, danish, korean, norwegian, turkish, indian (hindi), indian (gujarati), filipino, polish, ukraine, greek
  • api_token - your api token.

You can pass additional parameters:

  • comment - Here you can specify additional information for translators.

Response will be in JSON format. You will get order_id and order_total.

{
   "mode":"live",
   "status":"success",
   "order_id":123, // order_id will be set only when wallet is charged (live mode)
   "order_total":12.34 // $12.34 dollars
   "in_wallet":0, // how much money you have left in your GoTranscript wallet
} 

When file will be finished, POST request will be sent to your specified URL. It will contain this data:

{
    'mode' => 'live',
    'order_id' => 123,
    'translation_url' => 'https://gotranscript.com/api/v4/test-file/2?api_token=login_to_see_token',
} 

When your server receives data, it must output ok. If it will not output ok, we will send this request again every hour up to 10 times.

To test how your server responds to request from gotranscript.com, click on link below.

Test translation request to your server

Captions Example

Send POST request to GoTranscript to order captions.

<?php

$url = 'https://gotranscript.com/api/v4/captions';
$data = [
    'mode' => 'test',
    'url' => 'https://gotranscript.com/tests/api/audio.mp3', // your file url
    'language' => 'english',
    'api_token' => 'login_to_see_token', // this is your API token
];
echo curlPost($url, $data); // function definition can be found at the bottom of documentation 
  • mode - When set to "test", file price is calculated but not charged from your wallet. This way you can test how much it will cost to make an order. When you want to make a real order, change "test" to "live".
  • url - file url you want to transcribe.
  • language - language of file. Values: english, french, spanish, italian, lithuanian, filipino, russian, polish, portuguese, dutch, german, turkish, croatian, arabic, chinese, japanese, greek, hebrew, finnish, hungarian, swedish, korean, estonian, indian, romanian, norwegian, malay, luxembourgish, danish, icelandic, nepali, ukraine
  • api_token - your api token.

You can pass additional parameters:

  • comment - Here you can specify names of speakers or other information for subtitlers.
  • from - Start file transcription from this amount of seconds (integer).
  • till - Finish file transcription at this amount of seconds (integer).
  • turnaround_time - values: 1_days, 2_days, 3_days, 4_days, 5_days (default)
  • number_of_speakers - values: 1_or_2 (default), 3_or_more

Response will be in JSON format.

{
   "mode":"live",
   "status":"success",
   "order_id":123, // order_id will be set only when wallet is charged (live mode)
   "order_total":12.34 // $12.34 dollars
   "in_wallet":0, // how much money you have left in your GoTranscript wallet
} 

When file will be finished, POST request will be sent to your specified URL. It will contain this data:

{
    'mode' => 'live',
    'order_id' => 123,
    'captions_url' => 'https://gotranscript.com/api/v4/test-file/1?api_token=login_to_see_token',
} 

When your server receives data, it must output ok. If it will not output ok, we will send this request again every hour up to 10 times.

To test how your server responds to request from gotranscript.com, click on link below.

Test captions request to your server

Subtitles Example

Send POST request to GoTranscript to order subtitles.

<?php

$url = 'https://gotranscript.com/api/v4/subtitles';
$data = [
    'mode' => 'test',
    'url' => 'https://gotranscript.com/tests/api/audio.mp3', // your file url
    'translate_from' => 'english',
    'translate_to' => 'german',
    'api_token' => 'login_to_see_token', // this is your API token
];
echo curlPost($url, $data); // function definition can be found at the bottom of documentation 
  • mode - When set to "test", file price is calculated but not charged from your wallet. This way you can test how much it will cost to make an order. When you want to make a real order, change "test" to "live".
  • url - file url you want to transcribe.
  • translate_from - translate from language. Values: english, french, italian, spanish, lithuanian, romanian, portuguese, german, arabic, japanese, chinese, russian, dutch, danish, korean, norwegian, turkish, indian (hindi), indian (gujarati), filipino, polish, ukraine, greek
  • translate_to - translate to language. Values: english, french, italian, spanish, lithuanian, romanian, portuguese, german, arabic, japanese, chinese, russian, dutch, danish, korean, norwegian, turkish, indian (hindi), indian (gujarati), filipino, polish, ukraine, greek
  • api_token - your api token.

You can pass additional parameters:

  • comment - Here you can specify additional information for subtitles.

Response will be in JSON format. You will get order_id and order_total.

{
   "mode":"live",
   "status":"success",
   "order_id":123, // order_id will be set only when wallet is charged (live mode)
   "order_total":12.34 // $12.34 dollars
   "in_wallet":0, // how much money you have left in your GoTranscript wallet
} 

When file will be finished, POST request will be sent to your specified URL. It will contain this data:

{
    'mode' => 'live',
    'order_id' => 123,
    'subtitles_url' => 'https://gotranscript.com/api/v4/test-file/2?api_token=login_to_see_token',
} 

When your server receives data, it must output ok. If it will not output ok, we will send this request again every hour up to 10 times.

To test how your server responds to request from gotranscript.com, click on link below.

Test subtitles request to your server

Other

curlPost()

This is curlPost() function that sends POST request using CURL. It is used in examples.

function curlPost($url, array $data) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    $response = curl_exec($ch);
    curl_close($ch);

    return $response;
}             

Monitoring Orders

When api is used in live mode (not in testing), you can go to login. There you will see your orders and their statuses.

Discount

All orders made through API receive 20% discount.

Need help? Contact us: info@gotranscript.com