Chatrooms

Translate a text chatroom message into the viewer language.

Translates one text chatroom message into preferred_language. This operation requires an active subscription for the end-user. The message body is translated by Mind Upload, and repeated requests may return a cached translation until the source message changes. Reply quotes and media tags are ignored so only the human-readable text body is translated. Very large text messages may be rejected with a validation error before work starts.

post/v1/translate_chatroom_message

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/translate_chatroom_message
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

usernamestring nullable

The end-user's username.

passwordstring nullable

The end-user's password on first sign-in. After login/register, send the returned session token (JWT) here instead — the field accepts either, and reusing the token keeps raw passwords out of your storage.

chatroom_idstring nullable

Chatroom id as returned by chatroom operations.

message_idstring nullable

Chatroom message id.

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
translated_textstring nullable
target_languagestring nullable
cachedboolean nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.