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

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

200

application/json

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",
      "id": "text",
      "status": "pending",
      "source": {
        "space": "text",
        "language": "en"
      },
      "language": "en",
      "instructions": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "result": {
        "space": "text",
        "revision": "text"
      },
      "createdAt": "2025-08-26T23:19:07.272Z",
      "updatedAt": "2025-08-26T23:19:07.272Z",
      "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

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

languagestring · enumRequiredPossible values:

Responses

201

Translation has been created

application/json

400

Bad Request

application/json

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: 294

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

{
  "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"
        }
      }
    ]
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2025-08-26T23:19:07.272Z",
  "updatedAt": "2025-08-26T23:19:07.272Z",
  "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

Path parameters

organizationIdstringRequired

The unique id of the organization

translationIdstringRequired

The unique id of the translation

Responses

200

application/json

404

No matching translation found

application/json

get

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"
        }
      }
    ]
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2025-08-26T23:19:07.272Z",
  "updatedAt": "2025-08-26T23:19:07.272Z",
  "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

Path parameters

organizationIdstringRequired

The unique id of the organization

translationIdstringRequired

The unique id of the translation

Body

Responses

200

Translation has been updated

application/json

400

Bad Request

application/json

put

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: 236

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

{
  "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"
        }
      }
    ]
  },
  "result": {
    "space": "text",
    "revision": "text"
  },
  "createdAt": "2025-08-26T23:19:07.272Z",
  "updatedAt": "2025-08-26T23:19:07.272Z",
  "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

Path parameters

organizationIdstringRequired

The unique id of the organization

translationIdstringRequired

The unique id of the translation

Responses

204

Translation did not exist

205

Translation has been deleted

delete

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

Path parameters

organizationIdstringRequired

The unique id of the organization

translationIdstringRequired

The unique id of the translation

Responses

204

Translation run triggered

404

No matching translation found

application/json

post

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

No content

Was this helpful?

{ "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]" ] }, "result": { "space": "text", "revision": "text" }, "createdAt": "2025-08-26T23:19:07.272Z", "updatedAt": "2025-08-26T23:19:07.272Z", "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" } } ] }

POST /v1/orgs/{organizationId}/translations HTTP/1.1 Host: api.gitbook.com Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 294 { "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" } } ] } }

{ "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" } } ] }, "result": { "space": "text", "revision": "text" }, "createdAt": "2025-08-26T23:19:07.272Z", "updatedAt": "2025-08-26T23:19:07.272Z", "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" } }

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