Translation

Represents the result of machine translating some status content

Examples

Translation of status with content warning and media

{
  "content": "<p>Hello world</p>",
  "spoiler_text": "Greatings ahead",
  "media_attachments": [
    {
      "id": "22345792",
      "description": "Status author waving at the camera"
    }
  ],
  "poll": null,
  "detected_source_language": "es",
  "provider": "DeepL.com"
}

Translation of status with poll:

{
  "content": "<p>Should I stay or should I go?</p>",
  "spoiler_text": "",
  "media_attachments": [],
  "poll": {
    "id": "34858",
    "options": [
      {
        "title": "Stay" 
      },
      {
        "title": "Go"
      }
    ]
  },
  "detected_source_language": "ja",
  "provider": "DeepL.com"
}

Attributes

content

Description: HTML-encoded translated content of the status.
Type: String (HTML)
Version history:
4.0.0 - added

spoiler_text

Description: The translated spoiler warning of the status.
Type: String
Version history:
4.2.0 - added

poll optional

Description: The translated poll of the status.
Type: Translation::Poll
Version history:
4.2.0 - added

media_attachments

Description: The translated media descriptions of the status.
Type: Array of Translation::Attachment
Version history:
4.2.0 - added

detected_source_language

Description: The language of the source text, as auto-detected by the machine translation provider.
Type: String (ISO 639 language code)
Version history:
4.0.0 - added

provider

Description: The service that provided the machine translation. Type: String
Version history:
4.0.0 - added

Translation::Poll attributes

id

Description: The ID of the poll.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.2.0 - added

options

Description: The translated poll options.
Type: Array of Translation::Poll::Option
Version history:
4.2.0 - added

Translation::Poll::Option attributes

title

Description: The translated title of the poll option.
Type: String
Version history:
4.2.0 - added

Translation::Attachment attributes

id

Description: The id of the attachment.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.2.0 - added

description

Description: The translated description of the attachment.
Type: String
Version history:
4.2.0 - added

See also

POST /api/v1/statuses/:id/translate
app/serializers/rest/translation_serializer.rb

Last updated April 2, 2024 · Improve this page