Translations languages

Manage the individual language configurations for your docs translation setup.

Enable or disable specific languages, configure default text direction, or adjust advanced translation settings to ensure clarity for your global audience.

The TranslationLanguageSettings object

Attributes

objectstring · enumrequiredAvailable options:

languagestring · enumrequiredAvailable options:

instructionsobjectrequired

urlsobjectrequired

URLs associated with the object

The TranslationLanguageSettings object

{
  "object": "translation-language-settings",
  "language": "en",
  "instructions": {
    "object": "document",
    "data": {
      "schemaVersion": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "key": "text",
        "nodes": [
          "[Circular Reference]"
        ],
        "isVoid": false,
        "data": {}
      }
    ]
  },
  "urls": {
    "location": "https://example.com"
  }
}

List all translation settings language

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

Query parameters

pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations/{translationSettingsId}/languages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "translation-language-settings",
      "language": "en",
      "instructions": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

OK

Get a translation settings language

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

translationLanguagestring · enumrequired

The language of the translation

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "object": "translation-language-settings",
  "language": "en",
  "instructions": {
    "object": "document",
    "data": {
      "schemaVersion": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "key": "text",
        "nodes": [
          "[Circular Reference]"
        ],
        "isVoid": false,
        "data": {}
      }
    ]
  },
  "urls": {
    "location": "https://example.com"
  }
}

OK

Create or update a translation settings language

put

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

translationLanguagestring · enumrequired

The language of the translation

Available options:

Body

instructionsobjectrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "instructions": {
      "object": "document",
      "data": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "key": "text",
          "nodes": [
            "[Circular Reference]"
          ],
          "isVoid": false,
          "data": {}
        }
      ]
    }
  }'

200

201

400

404

200

{
  "object": "translation-language-settings",
  "language": "en",
  "instructions": {
    "object": "document",
    "data": {
      "schemaVersion": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "key": "text",
        "nodes": [
          "[Circular Reference]"
        ],
        "isVoid": false,
        "data": {}
      }
    ]
  },
  "urls": {
    "location": "https://example.com"
  }
}

Language settings successfully updated

Remove a translation settings language

delete

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

translationLanguagestring · enumrequired

The language of the translation

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

205

404

205

No Content

Language successfully removed