Translations

Configure multi-language support and translation options for your documentation.

The Translations API provides ways to localize your content into various languages. It supports custom strings, default language settings, and more.

The TranslationSettings object

Attributes

objectstring · enumrequiredAvailable options:

idstringrequired

Unique identifier of the translation settings

titlestring · min: 1 · max: 100required

Title of the translation settings

languagesstring · enum[]required

createdAtstring · date-timerequired

updatedAtstring · date-timerequired

permissionsobjectrequired

urlsobjectrequired

URLs associated with the object

The TranslationSettings object

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-04-12T21:04:01.096Z",
  "updatedAt": "2025-04-12T21:04:01.096Z",
  "permissions": {
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

List all the translation settings

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestringoptional

Identifier of the page results to fetch.

limitnumber · max: 1000optional

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "translation-settings",
      "id": "text",
      "title": "text",
      "languages": [
        "en"
      ],
      "createdAt": "2025-04-12T21:04:01.096Z",
      "updatedAt": "2025-04-12T21:04:01.096Z",
      "permissions": {
        "edit": true
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

OK

Create a translation settings

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

titlestringrequired

The title of the translation settings

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text"
  }'

201

400

201

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-04-12T21:04:01.096Z",
  "updatedAt": "2025-04-12T21:04:01.096Z",
  "permissions": {
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Translation settings has been created

Get a translation settings by its ID

get

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-04-12T21:04:01.096Z",
  "updatedAt": "2025-04-12T21:04:01.096Z",
  "permissions": {
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

OK

Update a translation settings

put

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

Body

titlestringrequired

The title of the translation settings

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/translations/{translationSettingsId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text"
  }'

200

400

200

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-04-12T21:04:01.096Z",
  "updatedAt": "2025-04-12T21:04:01.096Z",
  "permissions": {
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Translation settings has been updated

Delete a translation settings

delete

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

translationSettingsIdstringrequired

The unique id of the translation settings

Responses

cURL

JavaScript

Python

HTTP

cURL

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

205

205

No Content

Translation settings has been deleted