Sign in
Integrations

Workspace plugin translate

Changed on

Run the Google Drive Workspace plugin translate command.

post/v1/integrations/workspace-plugin/translate

Request

  • Base URL: https://api.gtx.dev
  • URL: https://api.gtx.dev/v1/integrations/workspace-plugin/translate
  • Auth: HTTP bearer

Request body

projectIdstring required

GT project ID returned by get_google_drive_context. The project must have a Google Drive integration connected in the GT dashboard.

fileIdstring required

File ID assigned by Google Drive, found in the Google Docs or Slides URL after /d/. This is not a GT database file ID. May identify a source file or a GT-managed translated copy.

hostApp'DOCS' | 'SLIDES' required

Google editor for the file: DOCS for Google Docs or SLIDES for Google Slides.

targetLocalesstring[] required

One to 100 supported target locale codes, such as fr or es-MX. Must respect the project locale whitelist. For a GT-managed translated copy, only that copy’s target locale is used.

sourceLocalestring

Optional source locale code, such as en. Defaults to the file’s stored source locale, then the project default. Ignored for a GT-managed translated copy, whose original source locale is used.

forceboolean

Whether to force retranslation of existing translations. Defaults to false. Retranslation may incur additional translation charges.

Response

Workspace plugin result

acceptedboolean required
sourceLocalestring required
targetLocalesstring[] required
enqueuednumber required
failednumber required
errorsstring[] required

Changes

  • ad476fb58be4Revision changes
    • warning

      the request property's maxLength was set to 128

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the media type text/html for the response with the status

    • info

      added the non-success response with the status

  • 06d55412bfebRevision changes
    • info

      endpoint added