API Endpoints
- GET /
Server handshake.
Return a JSON response containing information about the available languages/models and the currently in use src/dst language and box/ocr/tsl models.
- Status Codes:
405 Method Not Allowed – Method not allowed.
200 OK – A JSON dictionary with handshake info.
- GET /get_trans/
Get translation.
Return a JSON response containing all the available translation of the specified text.
- Query Parameters:
text (string) – The text for which to search for translations. (Required)
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
404 Not Found – Text not found.
512 – Attempting translation with no languages selected.
200 OK – A JSON dictionary with the translation.
- POST /set_lang/
Set source and destination languages.
Set the source and destination languages for the translation.
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
200 OK – Success.
- POST /set_models/
Set box, ocr and tsl models.
Set the box, ocr and tsl models for the translation.
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
200 OK – Success.
- POST /run_tsl/
Run translation on text.
Run translation on text using active model.
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
512 – Attempting translation with no languages selected.
513 – Attempting translation with no models selected.
200 OK – A JSON dictionary with the translated text.
- POST /run_ocrtsl/
Run OCR and translation on image.
Run OCR and translation on image () using active models.
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
406 Not Acceptable – Can’t lazyload with only md5.
512 – Attempting translation with no languages selected.
513 – Attempting translation with no models selected.
200 OK – A JSON dictionary with the translated text.
- GET /run_tsl_get_xunityautotrans
Run translation from a GET endpoint.
Runt translation of text with API compatible with https://github.com/bbepis/XUnity.AutoTranslator.
- Query Parameters:
text (string) – The text to translate. (Required)
- Status Codes:
404 Not Found – Text not found.
405 Method Not Allowed – Method not allowed.
200 OK – Success.
- POST /set_manual_translation
Set manual translation.
Set manual translation for a text object.
- Status Codes:
400 Bad Request – Bad request.
404 Not Found – Text not found.
405 Method Not Allowed – Method not allowed.
512 – Attempting translation with no languages selected.
200 OK – Success.
- GET /get_active_options
Get active options.
Get the active options for the OCR and translation.
- Status Codes:
405 Method Not Allowed – Method not allowed.
200 OK – A JSON dictionary with the active options.
- GET /get_plugin_data
Get the data of the available plugins
Get a dict of available plugins and their data, including if they are installed or not.
- Status Codes:
405 Method Not Allowed – Method not allowed.
200 OK – A JSON dictionary with the plugin data.
- POST /manage_plugins
Manage plugins.
Manage the plugins, by installing/uninstalling them.
- Status Codes:
400 Bad Request – Bad request.
405 Method Not Allowed – Method not allowed.
200 OK – Success.