Welcome to the Maestra API
Maestra API Version: 1.3.1
Base URL:
If you have any questions, please contact to us at support@maestra.ai
Import
POST /api/uploadFile
Initiates a new file upload to Maestra.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Item created.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
POST /api/importSubtitle
Initiates a new subtitle file upload.
This can potentially be a destructive operation, the sentences in the current file will be replaced with the imported subtitles and all the previous edits will be lost.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Item created.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
Translate
POST /api/translate
Translates an existing file in the system.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Translation created.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
404
Not found
Voiceover
POST /api/generateVoiceover
Generates voiceover for a specific language.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Voiceover synthesis started.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
404
Not found
POST /api/setDefaultSpeakers
Sets the default speakers for various languages.
Parameters
Content-Type application/json
Body (body)
Responses
200
Default speakers set successfully.
Example Value
400
Bad request, invalid parameters.
401
Unauthorized
POST /api/exportVoiceover
Exports voiceover for a specific file ID and language.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Voiceover export started.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
404
Not found
GET /api/getVoiceSample
Retrieves a voice sample for a given voice ID and language.
Parameters
voiceId string (query)
The ID of the voice sample to retrieve.
language string (query)
The language of the voice sample to retrieve.
Responses
200
Voice sample retrieved successfully.
Example Value
400
Bad request, invalid parameters.
401
Unauthorized
GET /api/listVoices
Lists all available voices, optionally grouped by language.
Parameters
groupByLanguage boolean (query)
When set to true, groups the voices by their respective languages.
Responses
200
Voices listed successfully.
File System
GET /api/getFiles
Grabs the file list with key id and basic information.
Parameters
apiKey string (header)
fileId (optional) string (query)
optional parameter to get a single file instead of the file list
operationType (optional) string (query)
transcript, caption, voiceover
Responses
200
Search results matching criteria.
Example Value
401
Unauthorized
GET /api/getFolders
Grabs the folder structure for the user account.
Parameters
apiKey string (header)
operationType (optional) string (query)
transcript, caption, voiceover
Responses
200
Search results matching criteria.
Example Value
401
Unauthorized
GET /api/getChannels
Grabs the channel list with key id and fetches channel information.
Parameters
apiKey string (header)
Responses
200
Search results matching criteria.
Example Value
401
Unauthorized
POST /api/moveFile
Moves a file to a specific channel/folder.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Item moved.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
POST /api/createFolder
Creates a new folder within file system.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Item created.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
POST /api/createChannel
Creates a new channel inside the team associated with apiKey.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
200
Channel created.
Example Value
400
Invalid url, invalid body.
401
Unauthorized
Export
POST /api/exportFile
Initiates a new export job.
Parameters
Content-Type application/json
apiKey string (header)
requestObject (body)
Example Value
Responses
201
Export job started.
Example Value
400
Invalid input, object invalid.
401
Unauthorized
Dictionary
GET /api/dictionary
Grabs the dictionary list with key ID.
Parameters
searchString string (query)
pass dictionary key if left empty will grab a map of dictionary
Responses
200
Search results matching criteria.
Example Value
400
Bad input parameter.
401
Unauthorized
POST /api/dictionary
Adds a dictionary item.
Parameters
Content-Type application/json
requestObject (body)
Adds a phrase to the dictionary
Example Value
Responses
201
Item created.
Example Value
400
Invalid input, object invalid.
401
Unauthorized
Organizational
GET /api/getCredits
Returns the available credit allotment within the account.
Parameters
apiKey string (header)
Responses
200
Search results matching criteria.
Example Value
401
Unauthorized
Models
DictionaryItem
DictionaryMap
DictionaryRequest
ExportRequest
ExportResponse
FilesMap
UploadRequest
UploadResponse
ImportSubtitleRequest
ImportSubtitleResponse
TranslateRequest
TranslateResponse
MoveRequest
MoveResponse
CreateFolderRequest
CreateFolderResponse
CreateChannelRequest
CreateChannelResponse
Languages
Transcription Languages
Code | Language | English Name |
---|---|---|
"af-ZA" | Afrikaans (Suid-Afrika) | Afrikaans (South Africa) |
"am-ET" | አማርኛ (ኢትዮጵያ) | Amharic (Ethiopia) |
"hy-AM" | Հայ (Հայաստան) | Armenian (Armenia) |
"az-AZ" | Azərbaycan (Azərbaycan) | Azerbaijani (Azerbaijan) |
"id-ID" | Bahasa Indonesia (Indonesia) | Indonesian (Indonesia) |
"ms-MY" | Bahasa Melayu (Malaysia) | Malay (Malaysia) |
"bn-BD" | বাংলা (বাংলাদেশ) | Bengali (Bangladesh) |
"bn-IN" | বাংলা (ভারত) | Bengali (India) |
"ca-ES" | Català (Espanya) | Catalan (Spain) |
"cs-CZ" | Čeština (Česká republika) | Czech (Czech Republic) |
"da-DK" | Dansk (Danmark) | Danish (Denmark) |
"de-DE" | Deutsch (Deutschland) | German (Germany) |
"en-US" | English | English |
"es-ES" | Español (España) | Spanish (Spain) |
"es-US" | Español (Estados Unidos) | Spanish (United States) |
"eu-ES" | Euskara (Espainia) | Basque (Spain) |
"fil-PH" | Filipino (Pilipinas) | Filipino (Philippines) |
"fr-CA" | Français (Canada) | French (Canada) |
"fr-FR" | Français (France) | French (France) |
"gl-ES" | Galego (España) | Galician (Spain) |
"ka-GE" | ქართული (საქართველო) | Georgian (Georgia) |
"gu-IN" | ગુજરાતી (ભારત) | Gujarati (India) |
"hr-HR" | Hrvatski (Hrvatska) | Croatian (Croatia) |
"zu-ZA" | IsiZulu (Ningizimu Afrika) | Zulu (South Africa) |
"is-IS" | Íslenska (Ísland) | Icelandic (Iceland) |
"it-IT" | Italiano (Italia) | Italian (Italy) |
"jv-ID" | Jawa (Indonesia) | Javanese (Indonesia) |
"kn-IN" | ಕನ್ನಡ (ಭಾರತ) | Kannada (India) |
"km-KH" | ភាសាខ្មែរ (កម្ពុជា) | Khmer (Cambodia) |
"lo-LA" | ລາວ (ລາວ) | Lao (Laos) |
"lv-LV" | Latviešu (latviešu) | Latvian (Latvia) |
"lt-LT" | Lietuvių (Lietuva) | Lithuanian (Lithuania) |
"hu-HU" | Magyar (Magyarország) | Hungarian (Hungary) |
"ml-IN" | മലയാളം (ഇന്ത്യ) | Malayalam (India) |
"mr-IN" | मराठी (भारत) | Marathi (India) |
"nl-NL" | Nederlands (Nederland) | Dutch (Netherlands) |
"ne-NP" | नेपाली (नेपाल) | Nepali (Nepal) |
"nb-NO" | Norsk bokmål (Norge) | Norwegian Bokmål (Norway) |
"pl-PL" | Polski (Polska) | Polish (Poland) |
"pt-BR" | Português (Brasil) | Portuguese (Brazil) |
"pt-PT" | Português (Portugal) | Portuguese (Portugal) |
"ro-RO" | Română (România) | Romanian (Romania) |
"si-LK" | සිංහල (ශ්රී ලංකාව) | Sinhala (Sri Lanka) |
"sk-SK" | Slovenčina (Slovensko) | Slovak (Slovakia) |
"sl-SI" | Slovenščina (Slovenija) | Slovenian (Slovenia) |
"su-ID" | Urang (Indonesia) | Sundanese (Indonesia) |
"sw-TZ" | Swahili (Tanzania) | Swahili (Tanzania) |
"sw-KE" | Swahili (Kenya) | Swahili (Kenya) |
"fi-FI" | Suomi (Suomi) | Finnish (Finland) |
"sv-SE" | Svenska (Sverige) | Swedish (Sweden) |
"ta-IN" | தமிழ் (இந்தியா) | Tamil (India) |
"ta-SG" | தமிழ் (சிங்கப்பூர்) | Tamil (Singapore) |
"ta-LK" | தமிழ் (இலங்கை) | Tamil (Sri Lanka) |
"ta-MY" | தமிழ் (மலேசியா) | Tamil (Malaysia) |
"te-IN" | తెలుగు (భారతదేశం) | Telugu (India) |
"vi-VN" | Tiếng Việt (Việt Nam) | Vietnamese (Vietnam) |
"tr-TR" | Türkçe (Türkiye) | Turkish (Turkey) |
"ur-PK" | اردو (پاکستان) | Urdu (Pakistan) |
"ur-IN" | اردو (بھارت) | Urdu (India) |
"el-GR" | Ελληνικά (Ελλάδα) | Greek (Greece) |
"bg-BG" | Български (България) | Bulgarian (Bulgaria) |
"ru-RU" | Русский (Россия) | Russian (Russia) |
"sr-RS" | Српски (Србија) | Serbian (Serbia) |
"uk-UA" | Українська (Україна) | Ukrainian (Ukraine) |
"he-IL" | עברית (ישראל) | Hebrew (Israel) |
"ar-IL" | العربية (إسرائيل) | Arabic (Israel) |
"ar-JO" | العربية (الأردن) | Arabic (Jordan) |
"ar-AE" | العربية (الإمارات) | Arabic (United Arab Emirates) |
"ar-BH" | العربية (البحرين) | Arabic (Bahrain) |
"ar-DZ" | العربية (الجزائر) | Arabic (Algeria) |
"ar-SA" | العربية (السعودية) | Arabic (Saudi Arabia) |
"ar-IQ" | العربية (العراق) | Arabic (Iraq) |
"ar-KW" | العربية (الكويت) | Arabic (Kuwait) |
"ar-MA" | العربية (المغرب) | Arabic (Morocco) |
"ar-TN" | العربية (تونس) | Arabic (Tunisia) |
"ar-OM" | العربية (عُمان) | Arabic (Oman) |
"ar-PS" | العربية (فلسطين) | Arabic (State of Palestine) |
"ar-QA" | العربية (قطر) | Arabic (Qatar) |
"ar-LB" | العربية (لبنان) | Arabic (Lebanon) |
"ar-EG" | العربية (مصر) | Arabic (Egypt) |
"fa-IR" | فارسی (ایران) | Persian (Iran) |
"hi-IN" | हिन्दी (भारत) | Hindi (India) |
"th-TH" | ไทย (ประเทศไทย) | Thai (Thailand) |
"ko-KR" | 한국어 (대한민국) | Korean (South Korea) |
"cmn-Hant-TW" | 國語 (台灣) | Chinese, Mandarin (Traditional, Taiwan) |
"yue-Hant-HK" | 廣東話 (香港) | Chinese, Cantonese (Traditional, Hong Kong) |
"ja-JP" | 日本語(日本) | Japanese (Japan) |
"cmn-Hans-HK" | 普通話 (香港) | Chinese, Mandarin (Simplified, Hong Kong) |
"cmn-Hans-CN" | 普通话 (中国大陆) | Chinese, Mandarin (Simplified, China) |