Reference
Public Endpoints
Status
GET https://api.weglot.com/public/status
This endpoint is used as a health check. You can use it to check if the Weglot API is up and running.
[]This is only a health check endpoint, don't spam it.
List languages
GET https://api.weglot.com/public/languages
This endpoint returns all availaible languages.
Headers
Content-Type
string
application/json
[
{
"code": "af",
"local_name": "Afrikaans",
"english_name": "Afrikaans"
},
{
"code": "ar",
"local_name": "العربية\u200f",
"english_name": "Arabic"
},
{
"code": "az",
"local_name": "Azərbaycan dili",
"english_name": "Azerbaijani"
},
{
"code": "be",
"local_name": "Беларуская",
"english_name": "Belarusian"
},
{
"code": "bg",
"local_name": "български",
"english_name": "Bulgarian"
},
...
] Is language pair supported
GET https://api.weglot.com/public/languages/is-supported
Query Parameters
languageTo
string
The language you wish to translate to
languageFrom
string
The original language
Headers
Content-Type
string
application/json
{
"is_supported": true
}Authenticated Endpoints
Weglot requires an API key to allow access to its endpoints. You can register and get a Weglot API Key at: Register.
The API key is to be included in all API requests to the server in the URL as the value of the api_key parameter, as follows:
https://api.weglot.com/endpoint?api_key=my_api_key
Translate
POST https://api.weglot.com/translate?api_key=my_api_key
This endpoint retrieves all translations. It takes an array of sentences in an original language in input and outputs the same array of sentences but translated in another language. The body is sent in the JSON format
Query Parameters
api_key
string
Your Weglot API Key
Headers
Content-Type
string
application/json
Request Body
l_from
string
ISO 639-1 code of the original language
l_to
string
ISO 639-1 code of the destination language
words
array
Sentences in original language
words[t]
integer
Type of the word based on WordType resource
words[w]
string
Sentence to translate
bot
integer
Link to user agent based on BotType resource
request_url
string
URL where the request come from
title
string
Title of the page where these sentences come from
{
"l_from":"en",
"l_to":"fr",
"title":"My awesome page",
"request_url":"https:\/\/www.website.com\/",
"bot":0,
"from_words":[
"This is a blue car",
"This is a black car"
],
"to_words":[
"C'est une voiture bleue",
"C'est une voiture noire"
]
}You can find WordType and BotType resources at the end of this document.
Here is a simple request example:
POST /translate?api_key=my_api_key HTTP/1.1
Host: api.weglot.com
Content-Type: application/json
{
"l_from":"en",
"l_to":"fr",
"request_url":"https://www.website.com/",
"words":[
{"w":"This is a blue car", "t": 1},
{"w":"This is a black car", "t": 1}
]
}Resources
BotType
Used to define the source of a request.
Short-Name
Value
Description
HUMAN
0
Sent from human action
OTHER
1
Sent from unknown source
2
Sent from Google Bot
BING
3
Sent from Bing Bot
YAHOO
4
Sent from Yahoo Bot
BAIDU
5
Sent from Baidu Bot
YANDEX
6
Sent from Yandex Bot
WordType
Used to provide context over where the text we wish to translate comes from. Any general text node is of WordType 1. We use the WordType to classify translations on the admin dashboard.
Short name
Value
Description
OTHER
0
None of the elements below (deprecated)
TEXT
1
General text (used most of the time)
VALUE
2
The value of an input tag'svalueattribute
PLACEHOLDER
3
The value of an input tag's placeholderattribute
META_CONTENT
4
The value of a meta tags' content attribute
IFRAME_SRC
5
The src link to a page used in an iframe
IMG_SRC
6
The srcvalue of an imgtag
IMG_ALT
7
The alt value of an imgtag
PDF_HREF
8
A URL pointing to a PDF document
PAGE_TITLE
9
Text from title tag
EXTERNAL_LINK
10
External links when dashboard option is enabled
Last updated