This web service allows users to translate a topic.
- This web service relies on the use of a Translation AI profiles. See Create an AI profile.
- It is necessary to provide an
Ft-Calling-Appvalue when using Fluid Topics web services. See Fluid Topics calling app.
Translation providers cannot all translate the same source and target languages. Use the Get translation profile languages web service to check what languages are available for an AI profile.
An AI profile is linked to a specific translation provider. The translation style, quality, and accuracy differs greatly between translation engines.
| Method | Endpoint |
|---|---|
GET |
|
| Path parameter | Type | Description |
|---|---|---|
{mapId} |
String | Expects the id associated with the map. Users can get the id by listing maps. |
{contentId} |
String | The topic's unique identifier. |
| Query parameter | Type | Required? | Description |
|---|---|---|---|
translationProfileId |
String | Yes | An AI profile ID of type Translation. |
translationSourceLanguage |
String | No | The language for the content to translate. If missing, the translation engine tries to identify the language. Not providing a source language can result in inaccurate translations. Users should try to provide one, if possible. The value must be a ISO 639-1 language designator (for example, fr for French, or es for Spanish). Can be followed by a hyphen, and an ISO 3166-1 region designator in uppercase (for example, fr-CA for Canadian French, or es-ES for Castilian Spanish). |
translationDestinationLanguage |
String | Yes | The language to translate into. The value must be a ISO 639-1 language designator (for example, en for English, or es for Spanish). Can be followed by a hyphen, and an ISO 3166-1 region designator in uppercase (for example, en-US for American English, or es-MX for Mexican Spanish). |
Response body
The following code block is an example of a JSON response body when translating the Support topic of the API Reference Guide to French:
{
"content": "<div class=\"ft_node_extractor content-locale-en-US content-locale-en\">\n<p>Pour obtenir de l'aide sur les services web de Fluid Topics, contactez l'<a class=\"ft-external-link\" href=\"https://help.fluidtopics.com\" rel=\"noopener\">équipe du service clientèle de Fluid Topics.</a></p></div>",
"isTranslationError": false
}
| Field | Type | Description |
|---|---|---|
content |
String | The translated content of the topic, as JSON‑escaped HTML. |
isTranslationError |
Boolean | Indicates whether the translation succeeded or not. |
| Return code | Description |
|---|---|
200 OK |
Returns the translated content. |
For a comprehensive list of all possible return codes, see Return codes.