PricingLog inSign up

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 · enumRequiredPossible values:
languagestring · enumRequiredPossible values:

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
200
OK
application/json
Responseall of
get
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

Possible values:
Responses
200
OK
application/json
get
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

Possible values:
Body
Responses
200
Language settings successfully updated
application/json
put
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

Possible values:
Responses
205
Language successfully removed
delete
DELETE /v1/orgs/{organizationId}/translations/{translationSettingsId}/languages/{translationLanguage} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Was this helpful?