Using GoTranscript API you can submit files for:
When you will make an order, money will be deducted from your GoTranscript wallet.
Authentication is done with an api_token
parameter given in the request body.
Your api_token
is: login_to_see_token
if returned status code is 200
, it indicates that the request was fulfilled successfully and that no error was encountered.
if you receive a status code 400
, it typically indicate that there was an issue with the request that was sent. Among other things,
this could mean that you did not authenticate correctly, or that your request is malformed.
Return codes in the 500
range typically indicate that there is a server-side problem.
This means that we are having an issue on our end and cannot fulfill your request currently.
When a request is successful, a response body will typically be sent back in the form of a JSON
object.
Please take a look at API calls to see what data object will be given. In case of error, standard response
object will be given:
// HTTP 400 Bad Request Error Response
{
'mode' => 'string',
'status' => 'string',
'error' => 'string'
}
GoTranscript uses callbacks to notify your application when your requested job is done.
With every API request, an additional callback_url
parameter can be given.
The value of this parameter must be a valid HTTP URL address, which must be able to handle POST requests.
Set your website url down below.
In case you dont want to pass callback_url
parameter in every API call, you can set it globally here:
When your application receives a callback, it must output string ok. If it will not output ok, request will be repeated again every hour up to 10 times.
Send POST request to GoTranscript to order transcription.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: test , live . 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 | String | File url you want to transcribe. |
language | String | Language of file. List of available languages: english,arabic,bosnian,catalan,chinese-simplified,chinese-traditional,croatian,dutch,filipino,french,german,hebrew,indonesian,italian,japanese,korean,lithuanian,persian-dari,persian-farsi,portuguese,russian,serbian,spanish,swahili,swedish,turkish,vietnamese . |
comment | String | Here you can specify names of speakers or other information for transcribers. |
from | Integer | Start file transcription from this amount of seconds. |
till | Integer | Finish file transcription at this amount of seconds. |
text_format | String | Available values: clean_verbatim (default), full_verbatim |
timestamping | String | Available values: not_required (default), every_10_seconds , every_30_seconds , every_2_minutes , change_of_speaker |
turnaround_time | String | Available values: 12_hours , 1_days , 3_days , 5_days (default) |
number_of_speakers | String | Available values: 1_or_2 (default), 3_or_more |
callback_url | String | When order is finished, you can specify url which will be used for callback. |
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
"seconds":68, // order duration in seconds
"in_wallet":0, // how much money you have left in your GoTranscript wallet
"delivery_estimate":"2023-06-04 13:50:31", // (UTC time)
}
When file transcription is finished, POST request will be sent to your specified URL. It will contain JSON
:
{
'mode' => 'live',
'order_id' => 123,
'transcription_url' => 'https://gotranscript.com/api/v4/test-file/transcriptions?api_token=login_to_see_token',
'language' => 'english', // language of transcription
}
Transcription file format. transcription_url
returns .docx document. You can also get transcription in different formats by adding parameter to transcription_url
: docx, doc, pdf, text, html or json
Example: https://gotranscript.com/api/v4/test-file/transcriptions?api_token=login_to_see_token&format=json
To test how your server responds to request from gotranscript.com, click on the link below.
Send test response to your serverSend POST request to GoTranscript to order translation.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: test , live . 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 | String | File url you want to translate. |
translate_from | String | Translate from the given file text language. List of available languages: english,albanian,arabic,azerbaijani,bengali,bosnian,bulgarian,catalan,simplified-chinese,traditional-chinese,croatian,czech,danish,dutch,estonian,filipino,finnish,french,french-canadian,georgian,german,greek,hebrew,hungarian,indian-gujarati,indian-hindi,indian-tamil,indonesian,italian,japanese,korean,kurdish,kyrgyz,latvian,lithuanian,macedonian,malay,nepali,norwegian,pashto,persian-farsi,polish,portuguese-brazil,portuguese-portugal,romanian,russian,serbian,slovak,slovenian,somali,spanish-latin,spanish,swahili,swedish,thai,turkish,ukrainian,urdu,vietnamese . |
translate_to | String | Translate the given file text to a given language. List of available languages: english,albanian,arabic,azerbaijani,bengali,bosnian,bulgarian,catalan,simplified-chinese,traditional-chinese,croatian,czech,danish,dutch,estonian,filipino,finnish,french,french-canadian,georgian,german,greek,hebrew,hungarian,indian-gujarati,indian-hindi,indian-tamil,indonesian,italian,japanese,korean,kurdish,kyrgyz,latvian,lithuanian,macedonian,malay,nepali,norwegian,pashto,persian-farsi,polish,portuguese-brazil,portuguese-portugal,romanian,russian,serbian,slovak,slovenian,somali,spanish-latin,spanish,swahili,swedish,thai,turkish,ukrainian,urdu,vietnamese . |
comment | String | Here you can specify additional information for translators. |
callback_url | String | When order is finished, you can specify url which will be used for callback. |
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
"seconds":0, // order duration in seconds
"words":68, // order word count
"in_wallet":0, // how much money you have left in your GoTranscript wallet
"delivery_estimate":"2023-06-04 13:50:31", // (UTC time)
}
When file transcription is finished, POST request will be sent to your specified URL. It will contain JSON
:
{
'mode' => 'live',
'order_id' => 123,
'translation_url' => 'https://gotranscript.com/api/v4/test-file/translations?api_token=login_to_see_token'
}
To test how your server responds to request from gotranscript.com, click on the link below.
Send test response to your serverSend POST request to GoTranscript to order captions.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: test , live . 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 | String | File url you want to make captions for. |
language | String | Language of file. List of available languages: english,arabic,bosnian,catalan,chinese-simplified,chinese-traditional,croatian,dutch,filipino,french,german,hebrew,indonesian,italian,japanese,korean,lithuanian,persian-dari,persian-farsi,portuguese,russian,serbian,spanish,swahili,swedish,turkish,vietnamese . |
comment | String | Here you can specify names of speakers or other information for subtitlers. |
from | Integer | Start file transcription from this amount of seconds. |
till | Integer | Finish file transcription at this amount of seconds. |
text_format | String | Available values: clean_verbatim (default), full_verbatim |
timestamping | String | Available values: not_required (default), every_10_seconds , every_30_seconds , every_2_minutes , change_of_speaker |
turnaround_time | String | Available values: 12_hours , 1_days , 3_days , 5_days (default) |
number_of_speakers | String | Available values: 1_or_2 (default), 3_or_more |
callback_url | String | When order is finished, you can specify url which will be used for callback. |
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
"seconds":68, // order duration in seconds
"in_wallet":0, // how much money you have left in your GoTranscript wallet
"delivery_estimate":"2023-06-04 13:50:31", // (UTC time)
}
When file transcription is finished, POST request will be sent to your specified URL. It will contain JSON
:
{
'mode' => 'live',
'order_id' => 123,
'captions_url' => 'https://gotranscript.com/api/v4/test-file/captions?api_token=login_to_see_token',
'transcription_url' => 'https://gotranscript.com/api/v4/test-file/transcriptions?api_token=login_to_see_token',
'language' => 'english' // language of captions
}
To test how your server responds to request from gotranscript.com, click on the link below.
Send test response to your serverSend POST request to GoTranscript to order subtitles.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: test , live . 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 | String | File url you want to make subtitles for. |
translate_from | String | Language of file. List of available languages: english,albanian,arabic,azerbaijani,bengali,bosnian,bulgarian,catalan,simplified-chinese,traditional-chinese,croatian,czech,danish,dutch,estonian,filipino,finnish,french,french-canadian,georgian,german,greek,hebrew,hungarian,indian-gujarati,indian-hindi,indian-tamil,indonesian,italian,japanese,korean,kurdish,kyrgyz,latvian,lithuanian,macedonian,malay,nepali,norwegian,pashto,persian-farsi,polish,portuguese-brazil,portuguese-portugal,romanian,russian,serbian,slovak,slovenian,somali,spanish-latin,spanish,swahili,swedish,thai,turkish,ukrainian,urdu,vietnamese . |
translate_to | String | Subtitle the given file to a given language. List of available languages: english,albanian,arabic,azerbaijani,bengali,bosnian,bulgarian,catalan,simplified-chinese,traditional-chinese,croatian,czech,danish,dutch,estonian,filipino,finnish,french,french-canadian,georgian,german,greek,hebrew,hungarian,indian-gujarati,indian-hindi,indian-tamil,indonesian,italian,japanese,korean,kurdish,kyrgyz,latvian,lithuanian,macedonian,malay,nepali,norwegian,pashto,persian-farsi,polish,portuguese-brazil,portuguese-portugal,romanian,russian,serbian,slovak,slovenian,somali,spanish-latin,spanish,swahili,swedish,thai,turkish,ukrainian,urdu,vietnamese . |
comment | String | Here you can specify additional information for subtitles. |
callback_url | String | When order is finished, you can specify url which will be used for callback. |
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
"seconds":0, // order duration in seconds
"in_wallet":0, // how much money you have left in your GoTranscript wallet
"delivery_estimate":"2023-06-04 13:50:31", // (UTC time)
}
When file transcription is finished, POST request will be sent to your specified URL. It will contain JSON
:
{
'mode' => 'live',
'order_id' => 123,
'subtitles_url' => 'https://gotranscript.com/api/v4/test-file/subtitles?api_token=login_to_see_token'
}
To test how your server responds to request from gotranscript.com, click on the link below.
Send test response to your serverSend GET request to GoTranscript to get list of orders.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: live . |
cursor | String | This field is used to paginate results. The cursor parameter will be automatically filled in the next_page_url . |
Name | Type | Description |
---|---|---|
id | Integer | Order ID. |
type | String | Can be one of the following: transcriptions , captions , translations , subtitles . |
paid_at | String or null | The date and time the order was paid in UTC time. Null value if order is not paid yet. |
finished_at | String or null | The date and time the order was finished in UTC time. Null value if order is not finished yet. |
transcription_url | string | Transcription file url, will be served after order is finished. |
captions_url | string | Captions file url, will be served after order is finished. |
translation_url | string | Translations file url, will be served after order is finished. |
subtitles_url | string | Subtitles file url, will be served after order is finished. |
Response will be in JSON
format.
{
"orders": [
{
"id": 1,
"type": "captions",
"paid_at": "2022-11-20 21:00:00",
"finished_at": "2022-11-20 21:00:00",
"captions_url": "https://gotranscript.com/api/v4/orders/1/captions?api_token=login_to_see_token"
},
...
],
"next_page_url": https://gotranscript.com/api/v4/orders?mode=test&api_token=login_to_see_token&cursor=string
}
Send GET request to GoTranscript to get order.
Name | Type | Description |
---|---|---|
api_token | String | Your API token. Your current API token is: login_to_see_token |
mode | String | Can be one of the following: live . |
Order response description can be found here.
Response will be in JSON
format.
{
"data": {
"id": 1,
"type": "captions",
"paid_at": "2022-11-20 21:00:00",
"finished_at": "2022-11-20 21:00:00",
"captions_url": "https://gotranscript.com/api/v4/orders/1/captions?api_token=login_to_see_token"
]
}
}
When api is used in live mode (not in testing), you can go to login. There you will see your orders and their statuses.
After an order is finished, some file are randomly selected to check their quality. When errors are found, they are fixed and one more request is sent to your specified API url. This request looks the same as original. It can be ignored if you already downloaded the file or you can redownload the file to get a version with fixed errors.
Different file types can return different callback data, please take a look at every API Callback object section.