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

all ofoptional

application/json

get

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/translations/{translationSettingsId}/languages HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
      }
    }
  ]
}

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

objectoptional

application/json

get

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
  }
}

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

objectoptional

application/json

application/json

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "instructions": {
    "object": "document",
    "data": {
      "schemaVersion": 1,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "nodes": [
      {
        "object": "block",
        "type": "paragraph",
        "key": "text",
        "nodes": [
          "[Circular Reference]"
        ],
        "isVoid": false,
        "data": {}
      }
    ]
  }
}

{
  "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"
  }
}

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

delete

HTTPcURLJavaScriptPython

DELETE /v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No Content