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.

List all the translations

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/translations

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "translation",
      "id": "text",
      "status": "pending",
      "source": {
        "space": "text",
        "language": "en"
      },
      "language": "en",
      "instructions": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ],
        "meta": {
          "token": "text"
        }
      },
      "result": {
        "space": "text",
        "revision": "text"
      },
      "createdAt": "2026-03-18T10:35:22.283Z",
      "updatedAt": "2026-03-18T10:35:22.283Z",
      "stats": {
        "runs": 1,
        "totalWords": 1,
        "totalPages": 1,
        "totalDuration": 1,
        "latestRunDuration": 1,
        "latestPages": 1,
        "latestWords": 1
      },
      "permissions": {
        "view": true,
        "edit": true
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a translation

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

languagestring · enumRequiredPossible values:

Responses

201

Translation has been created

application/json

400

Bad Request

application/json

post

/orgs/{organizationId}/translations

HTTPcURLJavaScriptPython

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

{
  "source": {
    "space": "text",
    "language": "en"
  },
  "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": {
          "align": "start"
        }
      }
    ],
    "meta": {
      "token": "text"
    }
  }
}

{
  "object": "translation",
  "id": "text",
  "status": "pending",
  "source": {
    "space": "text",
    "language": "en"
  },
  "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": {
          "align": "start"
        }
      }
    ],
    "meta": {
      "token": "text"
    }
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2026-03-18T10:35:22.283Z",
  "updatedAt": "2026-03-18T10:35:22.283Z",
  "stats": {
    "runs": 1,
    "totalWords": 1,
    "totalPages": 1,
    "totalDuration": 1,
    "latestRunDuration": 1,
    "latestPages": 1,
    "latestWords": 1
  },
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a translation by its ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

translationIdstringRequired

The unique id of the translation

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier of the translation sync

statusstring · enumRequiredPossible values:

languagestring · enumRequiredPossible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

404

No matching translation found

application/json

get

/orgs/{organizationId}/translations/{translationId}

HTTPcURLJavaScriptPython

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

{
  "object": "translation",
  "id": "text",
  "status": "pending",
  "source": {
    "space": "text",
    "language": "en"
  },
  "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": {
          "align": "start"
        }
      }
    ],
    "meta": {
      "token": "text"
    }
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2026-03-18T10:35:22.283Z",
  "updatedAt": "2026-03-18T10:35:22.283Z",
  "stats": {
    "runs": 1,
    "totalWords": 1,
    "totalPages": 1,
    "totalDuration": 1,
    "latestRunDuration": 1,
    "latestPages": 1,
    "latestWords": 1
  },
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Update a translation

put

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

translationIdstringRequired

The unique id of the translation

Body

application/json

Responses

200

Translation has been updated

application/json

objectstring · enumRequiredPossible values:

idstringRequired

Unique identifier of the translation sync

statusstring · enumRequiredPossible values:

languagestring · enumRequiredPossible values:

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

400

Bad Request

application/json

put

/orgs/{organizationId}/translations/{translationId}

HTTPcURLJavaScriptPython

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

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

{
  "object": "translation",
  "id": "text",
  "status": "pending",
  "source": {
    "space": "text",
    "language": "en"
  },
  "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": {
          "align": "start"
        }
      }
    ],
    "meta": {
      "token": "text"
    }
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2026-03-18T10:35:22.283Z",
  "updatedAt": "2026-03-18T10:35:22.283Z",
  "stats": {
    "runs": 1,
    "totalWords": 1,
    "totalPages": 1,
    "totalDuration": 1,
    "latestRunDuration": 1,
    "latestPages": 1,
    "latestWords": 1
  },
  "permissions": {
    "view": true,
    "edit": true
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a translation

delete

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

translationIdstringRequired

The unique id of the translation

Responses

204

Translation did not exist

205

Translation has been deleted

delete

/orgs/{organizationId}/translations/{translationId}

HTTPcURLJavaScriptPython

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

No content

Run a translation again

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

translationIdstringRequired

The unique id of the translation

Responses

204

Translation run triggered

404

No matching translation found

application/json

post

/orgs/{organizationId}/translations/{translationId}/run

HTTPcURLJavaScriptPython

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

No content