This endpoint allows (the actual) translating.

Parameters

Required

• hoster: The place to host the output video. Available Options: (case-sensitive)

  • ftp: Hosts via FTP / Oojmed (https://v.oojmed.com)
  • imgur: Hosts via Imgur

• lang: The sign language to translate into. Available Options: (case-sensitive)

  • BSL: British Sign Language
  • ASL: American Sign Language
  • DGS: German Sign Language / Deutsche Gebärdensprache
  • LSE: French Sign Language / Langue des Signes Française
  • LSF: Spanish Sign Language / Lengua de Signos Española
  • ISL: International Sign Language
  • LSC: Catalan Sign Language / Llengua de Signes Catalana
  • Auslan: Auslan / Australian Sign Language

• text: The text to translate.

Optional

• overallSpeed: Default: 100. The overall speed of the output video. As a percentage (without %) (150 = 150%, 50 = 50%, etc.). Limit: 50% - 150%.
• individualSpeed: Default: 100. The speed of individual letters (usually when spelling things out). As a percentage (without %) (150 = 150%, 50 = 50%, etc.). Limit: 50% - 150%.

• quality: Default 360. The quality of the output video. Given as a number (144 = 144p, 360 = 360p). Avaliable options:

  • 144
  • 240
  • 360
  • 480

• redirect: Default: true. Whether to redirect to the URL (true) or send it in the response body (false).

• progressKey: Default: undefined. The progress key to send feedback with.

Response

• If redirect is true, the server will redirect (returning a 302 HTTP status code), which will redirect to the uploaded GIF.
• If redirect is false, the server will return the uploaded GIF's URL (returning a 200 HTTP status code).

This endpoint allows getting version information about the server.

Parameters

• None

Response

All dates and times are in UNIX Timestamps, in milliseconds, not seconds.

Format

{header}; {text}
{header}; {text}

• header: A header / title of information.
• text: The actual text / information about the header.

Example

Uptime; 4 hours, 9 minutes, 26 seconds
Translations (during server session); 0 total

Interpreter; 2019-09-28.1
Passer; 2019-09-24.1
Compressor; 2019-09-07.3
Engine; 2019-09-21.2

All Caches; 274 files | 42.20MB | Latest Update - 1569664588821
BSL Cache; 214 files | 30.50MB | Latest Update - 1569664588821
ASL Cache; 36 files | 6.78MB | Latest Update - 1569663525562
DGS Cache; 18 files | 3.31MB | Latest Update - 1568307943610
LSF Cache; 4 files | 0.99MB | Latest Update - 1567857116670
LSE Cache; 2 files | 0.62MB | Latest Update - 1567857263647

English Autoskip; 1568388013427
English Phrases; 1567010931443
English Synonyms; 1568060044730

German Autoskip; 1567791646040
German Phrases; 1567791772893
German Synonyms; 1567791820463

French Autoskip; 1567975379613
French Phrases; 1567975401390
French Synonyms; 1569009959143

Spanish Autoskip; 1567975435240
Spanish Phrases; 1567975418013
Spanish Synonyms; 1569009974356

This endpoint allows getting a progress key. Progress keys are not required to be gotten this way, you can specify your own, but it is the recommended and best way.

Parameters

Optional

• prefix: Allows specifying a prefix to the progress key returned. The prefix has to be characters within the regex pattern: /[a-zA-Z0-9]/g (English letters and numbers), anything that does not match that pattern will be removed. If no prefix is provided, it will be set to '' (blank / nothing).

Response

The response is in plain text (text/plain).

Format

{prefix}-{id}

• prefix: The prefix parameter provided, explained above.
• id: The randomly generated ID, a random 128 bit hexadecimal string.

Example

APIDocs-70b23c8b4cb2ef30ac186f75fed61d9d5b25c39...

This endpoint allows getting a event stream for a progress key. This should be done after calling the /translate endpoint.

Parameters

Required

• progressKey: The progress key to get the event stream for.

Response

The response is an event stream (text/event-stream).

Example

...

data: Loading phrases...
data: Loading synonyms...
data: Interpreting...

...