API Documentation

API Documentation

Introduction

Installation

How to use it?

Request

Response

Example

Wiip Translate API

The Wiip API can be accessed with a subscription plan or with a personal demo for potential clients. The API is an interface that allows other computer programs to send texts to your servers and receive high-quality translations. This opens a whole universe of opportunities for developers worldwide: Any translation product you can imagine can now be built on top of Wiip’s neural translation technology.

Installation

The only requirement is to have Docker installed, everything else is bundled and provided withing our Docker containers.

  1.     Download our docker image.
  2.     Type ‘docker run wiip-translate’
  3.     That’s all? Yes

How to use it?

If you are a private user, just open your web browser and navigate to https://localhost/wiip-translate. If you intend to use it for multiple users or inside an organization, replace  ‘localhost’ with the IP of your host server. You will be able to drag and drop your documents or paste any text. It works exactly the same as our Wiip-translate online demo. Why should you pay for a service that many providers (i.e. Google Translate) offer for free? The difference is your privacy and the quality of your translations. All your texts remain in your hardware. And you can train the generic system to get a better accuracy in your specific domain. You can also use our service as an API, sending POST requests and processing the response as described below:

Request

After installing our solution you can start sending requests to your Wiip Translation server. The translate function allows to translate texts and is available at https://<yourIP>:3030/wiip-translate . This synchronous call supports the following basic parameters:

Parameter

Description

input_text

Required

UTF8-encoded plain text to be translated.

input_lang

Optional

Language of the input text to be translated.If no input_lang is specified, the system will automatically detect the language.

We currently support 28 language values:

“en” (English), “es” (Spanish), “de” (German), “fr” (French), “pt” (Portuguese), “it” (Italian), “nl” (Dutch), “pl” (Polish), “ru” (Russian), “ro” (Romanian), “ar” (Arabic), “bg” (Bulgarian), “cs” (Czech), “da” (Danish), “el” (Greek), “fa” (Persian), “hu” (Hungarian), “id” (Indonesian), “he” (Hebrew), “ja” (Japanese), “ko” (Korean), “ms” (Malay), “no” (Norwegian), “pl” (Polish), “sk” (Slovak), “sv” (Swedish), “th” (Thai), “zh” (Chinese)

output_lang

Required

Language of the translated text. Current supported languages are the same as input_lang.

Response

The translate function returns a JSON representation of the translations in the order the text parameters have been specified.

Return Value

Description

input_lang

The language detected in the source text. It reflects the value of the source_lang parameter when specified.

translation

The translated text.

Example

The following shows a basic request translating the text “hello”

CURL

EXAMPLE REQUEST :

curl https://:3030/wiip-translate \
  -d “input_text=hello” \
  -d “output_lang=de”

EXAMPLE RESPONSE :

{
    “translation”:  {
    “input_language”:“EN”,
    “output_text”:“hallo”
          }
}