@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api FunTranslations Braille API
@base https://api.funtranslations.com
@version 2.3
@auth ApiKey X-Funtranslations-Api-Secret in header
@endpoints 5
@toc translate(5)

@endpoint GET /translate/braille
@desc Translate from English to Braille. This is what you use if you have a braille display. This API translates the English text into characters that a braille display understands and you can feed the translated text directly to the display.
@required {text: any # Text to translate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /translate/braille/dots
@desc Use this to see which dots are enabled for each Braille letters. This is highly educational (to see which dots are enabled) and can potentially drive a non braille display which works on individual dots.
@required {text: any # Text to translate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /translate/braille/unicode
@desc Translate from English to Braille Unicode characters.
@required {text: any # Text to translate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /translate/braille/image
@desc Translate from English to Braille image characters. This is probably what you want to use if you are displaying braille in a browser.
@required {text: any # Text to translate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /translate/braille/html
@desc Translate from English to Braille Image characters. This is probably what you want to use if you are displaying braille in a browser.
@required {text: any # Text to translate}
@returns(200) 200  response
@errors {401: 401  response}

@end