Auto Translation
  • 18 Oct 2023
  • 1 Minute to read
  • Dark
    Light

Auto Translation

  • Dark
    Light

Article Summary

Auto Translation

You need the Manage Settings permission to manage Auto Translation.

Auto Translation JSON Format

Auto Translation is represented as simple flat JSON objects with the following keys:

NameTypeDescription
excludedWordsstring []Words/phrases that do not require translation.
isEnabledboolWhether auto translation is enabled or not.

Get a single Auto Translation

GET global/autoTranslationConfig

  • Parameters:

No Parameters

  • Response:

Auto Translation

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/autoTranslationConfig \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "excludedWords": [
      "Test"
  ],
  "isEnabled": true
} 

Disable the Auto Translation

POST global/autoTranslationConfig:disable

  • Parameters:

No Parameters

  • Response:

Auto Translation

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/autoTranslationConfig:disable \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "excludedWords": [
      "Test"
  ],
  "isEnabled": false
} 

Enable the Auto Translation

POST global/autoTranslationConfig:enable

  • Parameters:

No Parameters

  • Response:

Auto Translation

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/autoTranslationConfig:enable \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "excludedWords": [
      "Test"
  ],
  "isEnabled": true
} 

Update the Auto Translation

PUT global/autoTranslationConfig

  • Parameters:

NameTypeinRequiredDescription
excludedWordsstring []bodynoWords/phrases that do not require translation.
isEnabledboolbodynoWhether auto translation is enabled or not.
  • Response:

Auto Translation

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/autoTranslationConfig \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"excludedWords":["Test"],"isEnabled":true}' 

Response:

HTTP/1.1 200 OK

{
  "excludedWords": [
      "Test"
  ],
  "isEnabled": true
} 

Was this article helpful?

What's Next