Translation API

The Translate API allows clients to translate an SRT transcription. The input transcription is defined by an S3 bucket name and key along with the language.

How it Works

Clients provide an input transcription in SRT format to the Subly Translate API. Subly then translates the input and when finished writes the translated SRT to the requested location in an SRT file.

What You Need

Clients of the Translate API will need:

• An S3 bucket in AWS that is accessible by Subly (see below for bucket configuration)
• An API key to use in header x-api-key for all requests.

Endpoints

All API requests require the x-api-key header to be set with the API key received at registration.

API paths use base URL https://api.getsubly.com

Translate Request

Start translation of transcription

Endpoint: POST /translate

Body Format: Content-Type: application/json

Body

• input
  • transcription
    • bucket (string): Bucket containing the media
    • key (string): Key to identify the SRT file in the bucket
    • language (string): Language code for transcription e.g. en, en (see full list below)
    • type (string): Type of media (see full list below)
• output
  • bucket (string): Bucket to put output translated transcription
  • key (string): Directory to put output translated transcription to
  • languages (array of string): Language codes for translations e.g. fr, de (see full list below)

Example

{
  "input": {
    "media": {
      "bucket": "my-storage-bucket",
      "key": "my-transcription.srt",
      "language": "en"
    }
  },
  "output": {
    "bucket": "my-storage-bucket",
    "key": "my-translations",
    "languages": ["fr", "de", "nl"]
  }
}

Response

200 status for successful job

• status (string): COMPLETED or FAILED
• output (array)
  • type (string): SRT
  • bucket (string): Bucket containing the translated transcription
  • key (string): Key to identify the translated transcription in the bucket
  • language (string): Language code for the translated transcription

The output for each file will be in the directory <output-key>/<language>.srt

Example Response

{
  "status": "COMPLETED",
  "output": [
    {
      "type": "SRT",
      "bucket": "my-storage-bucket",
      "key": "my-translations/fr.srt",
      "language": "fr"
    },
    {
      "type": "SRT",
      "bucket": "my-storage-bucket",
      "key": "my-translations/de.srt",
      "language": "de"
    },
    {
      "type": "SRT",
      "bucket": "my-storage-bucket",
      "key": "my-translations/nl.srt",
      "language": "nl"
    }
  ]
}

Supported Options

Available Languages

Available languages for both input and output are:

• af: Afrikaans
• ak: Twi (Akan)
• am: Amharic
• ar: Arabic
• as: Assamese
• ay: Aymara
• az: Azerbaijani
• be: Belarusian
• bg: Bulgarian
• bho: Bhojpuri
• bm: Bambara
• bn: Bengali
• bs: Bosnian
• ca: Catalan
• ceb: Cebuano
• ckb: Kurdish (Sorani)
• co: Corsican
• cs: Czech
• cy: Welsh
• da: Danish
• de: German
• doi: Dogri
• dv: Dhivehi
• ee: Ewe
• el: Greek
• en: English
• eo: Esperanto
• es: Spanish
• et: Estonian
• eu: Basque
• fa: Persian
• fi: Finnish
• fil: Filipino (Tagalog)
• fr: French
• fy: Frisian
• ga: Irish
• gd: Scots Gaelic
• gl: Galician
• gn: Guarani
• gom: Konkani
• gu: Gujarati
• ha: Hausa
• haw: Hawaiian
• he: Hebrew
• hi: Hindi
• hmn: Hmong
• hr: Croatian
• ht: Haitian Creole
• hu: Hungarian
• hy: Armenian
• id: Indonesian
• is: Icelandic
• it: Italian
• ja: Japanese
• jw: Javanese
• ka: Georgian
• kk: Kazakh
• km: Khmer
• kn: Kannada
• ko: Korean
• kri: Krio
• ku: Kurdish
• ky: Kyrgyz
• la: Latin
• lb: Luxembourgish
• lg: Luganda
• ln: Lingala
• lo: Lao
• lt: Lithuanian
• lus: Mizo
• lv: Latvian
• mai: Maithili
• mg: Malagasy
• mi: Maori
• mk: Macedonian
• ml: Malayalam
• mn: Mongolian
• mni-Mtei: Meitei (Manipuri)
• mr: Marathi
• ms: Malay
• mt: Maltese
• my: Myanmar (Burmese)
• nb: Norwegian (Bokmål)
• ne: Nepali
• nl: Dutch
• no: Norwegian
• nso: Sepedi
• ny: Nyanja (Chichewa)
• om: Oromo
• or: Odia (Oriya)
• pa: Punjabi
• pl: Polish
• ps: Pashto
• pt: Portuguese (Portugal, Brazil)
• qu: Quechua
• ro: Romanian
• ru: Russian
• rw: Kinyarwanda
• sa: Sanskrit
• sd: Sindhi
• si: Sinhala (Sinhalese)
• sk: Slovak
• sl: Slovenian
• sm: Samoan
• sn: Shona
• so: Somali
• sq: Albanian
• sr: Serbian
• st: Sesotho
• su: Sundanese
• sv: Swedish
• sw: Swahili
• ta: Tamil
• te: Telugu
• tg: Tajik
• th: Thai
• ti: Tigrinya
• tk: Turkmen
• tl: Tagalog (Filipino)
• tr: Turkish
• ts: Tsonga
• tt: Tatar
• ug: Uyghur
• uk: Ukrainian
• ur: Urdu
• uz: Uzbek
• vi: Vietnamese
• xh: Xhosa
• yi: Yiddish
• yo: Yoruba
• zh: Chinese (Simplified)
• zh-TW: Chinese (Traditional)
• zu: Zulu

Available languages for input only are:

• en: English
• pt: Portuguese

Available languages for output only are:

• en-GB: English (British)
• en-US: English (US)
• pt-PT: Portuguese
• pt-BR: Portuguese (Brazilian)