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

idstringRequired

Unique identifier of the translation settings

titlestring · min: 1 · max: 100Required

Title of the translation settings

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

The TranslationSettings object

{
  "object": "translation-settings",
  "id": "text",
  "title": "text",
  "languages": [
    "en"
  ],
  "createdAt": "2025-04-24T17:12:36.361Z",
  "updatedAt": "2025-04-24T17:12:36.361Z",
  "permissions": {
    "view": true,
    "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

Responseall of

get

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

200

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

Create a translation settings

post

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestringRequired

The title of the translation settings

Responses

post

POST /v1/orgs/{organizationId}/translations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

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

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

get

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

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

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

put

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

{
  "title": "text"
}

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

Delete a translation settings

delete

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

translationSettingsIdstringRequired

The unique id of the translation settings

Responses

delete

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

205

Translation settings has been deleted

No content

Was this helpful?