Get Translation Providers

Prev Next
Get
/api/v1/autotranslate.getProviderUiMetadata

Lists the auto-translate providers registered in the workspace.

This endpoint replaces the deprecated autoTranslate.getProviderUiMetadata Realtime API method.

Changelog

Version Description
8.9.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Success Example
{
  "providers": {
    "google-translate": {
      "name": "google-translate",
      "displayName": "Google"
    },
    "deepl-translate": {
      "name": "deepl-translate",
      "displayName": "DeepL"
    },
    "microsoft-translate": {
      "name": "microsoft-translate",
      "displayName": "Microsoft"
    },
    "libre-translate": {
      "name": "libre-translate",
      "displayName": "LibreTranslate"
    }
  },
  "success": true
}
Expand All
object
providers
object

The registered providers, keyed by provider name.

property*
object additionalProperties
name
string

The provider name.

displayName
string

The provider name to display in the UI.

success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string