Mirai PF Text Translation API

https://miraitranslate.com/miraipf-mt-api-v2-public/
Admin
Mirai PF Text Translation API is a machine translation API developed by Mirai Translate Co., Ltd.,...
Tokens:5,084
Snippets:26
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Header Example for Translation Count

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Example of the X-Source-Word-Count header returned in successful responses.

```yaml
example: 1234
```

--------------------------------

### Translate Details Request Example

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Example JSON payload for the /mt/v2/translate/details endpoint, used to retrieve detailed translation results.

```json
{
  "sources": [
    "Who are you?",
    "Hello, I am MT."
  ],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
  ],
  "tmIds": [
    "translation-memory-1"
  ],
  "user-options": {
    "adaptPhrases": [
      {
        "source": "mirai translate",
        "target": "ã¿ã‚‰ã„ç¿»è¨³"
      },
      {
        "source": "MT",
        "target": "ã¿ã‚‰ã„ç¿»è¨³"
      }
    ],
    "concat": true,
    "jastyle": "j2k"
  }
}
```

--------------------------------

### Translate Request Example

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Example JSON payload for the /mt/v2/translate endpoint, including source text, dictionary IDs, and user options.

```json
{
  "sources": [
    "Who are you? My name is john.",
    "Hello, I am MT."
  ],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
  ],
  "tmIds": [
    "translation-memory-1"
  ],
  "user-options": {
    "adaptPhrases": [
      {
        "source": "mirai translate",
        "target": "ã¿ã‚‰ã„ç¿»è¨³"
      },
      {
        "source": "MT",
        "target": "ã¿ã‚‰ã„ç¿»è¨³"
      }
    ],
    "concat": true,
    "jastyle": "j2k"
  }
}
```

--------------------------------

### Translation API Response Examples

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

JSON payloads demonstrating successful standard translation and pivot translation responses.

```json
sourceLang: en
translationLang: ja
sources:
  - Who are you?
  - Hello, I am MT.
translations:
  - あなたは誰ですか？
  - こんにちは、私はみらい翻訳です。
```

```json
sourceLang: ja
intermediationLang: en
translationLang: fr
sources:
  - こんにちは
intermediations:
  - Hello
translations:
  - Bonjour
```

--------------------------------

### 翻訳実行リクエストのペイロード例

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

翻訳対象の原文、辞書ID、翻訳メモリID、および翻訳オプションを含むJSONリクエストボディの例です。

```json
{
  "sources": [
    "Who are you?",
    "Hello, I am MT."
],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
],
  "tmIds": [
    "translation-memory-1"
],
  "user-options": {
    "adaptPhrases": [
      {
        "source": "mirai translate",
        "target": "みらい翻訳"
},
      {
        "source": "MT",
        "target": "みらい翻訳"
}
],
    "concat": true,
    "jastyle": "j2k"
}
}
```

--------------------------------

### テキスト翻訳レスポンスサンプル

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

翻訳成功時(200 OK)に返される翻訳結果を含むJSONレスポンスの例。

```json
{
  "sourceLang": "en",
  "translationLang": "ja",
  "sources": [
    "Who are you?",
    "Hello, I am MT."
],
  "translations": [
    "あなたは誰ですか？",
    "こんにちは、私はみらい翻訳です。"
]

}
```

--------------------------------

### POST /translate

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Translates a list of source strings into the target language based on the provided profile and options.

```APIDOC
## POST /translate

### Description
Translates an array of source strings into a specified target language. Supports user-defined dictionaries, translation memories, and stylistic controls.

### Method
POST

### Endpoint
/translate

### Parameters
#### Query Parameters
- **langFrom** (string) - Required - Source language code.
- **langTo** (string) - Required - Target language code.
- **profile** (string) - Required - Translation profile identifier.

#### Request Body
- **sources** (array) - Required - Array of strings to translate (1-100 items, max 5000 chars each).
- **udIds** (array) - Optional - Array of user dictionary IDs or aliases.
- **tmIds** (array) - Optional - Array of translation memory IDs or aliases.
- **user-options** (object) - Required - Translation configuration options.
  - **concat** (boolean) - Required - Must be true for context-aware translation.
  - **jastyle** (string) - Optional - Style control for Japanese (j2k or k2j).
  - **adaptPhrases** (array) - Optional - On-demand dictionary entries.
- **userLog** (string) - Optional - Custom log string (max 64 chars).
- **appId** (string) - Optional - Custom application ID string (max 64 chars).

### Response
#### Success Response (200)
- **sources** (array) - Original source strings.
- **translations** (array) - Translated strings.
- **sourceLang** (string) - Detected or provided source language.
- **translationLang** (string) - Target language.
```

--------------------------------

### テキスト翻訳リクエストサンプル

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

翻訳対象のテキスト、辞書ID、翻訳メモリID、および翻訳オプションを含むJSONリクエストの例。

```json
{
  "sources": [
    "Who are you? My name is john.",
    "Hello, I am MT."
],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
],
  "tmIds": [
    "translation-memory-1"
],
  "user-options": {
    "adaptPhrases": [
      {
        "source": "mirai translate",
        "target": "みらい翻訳"
},
      {
        "source": "MT",
        "target": "みらい翻訳"
}
],
    "concat": true,
    "jastyle": "j2k"
}

}
```

--------------------------------

### 翻訳実行レスポンスの例

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

翻訳結果および詳細なプロセス情報（辞書適用箇所など）を含むレスポンスの例です。

```json
{
  "sourceLang": "ja",
  "intermediationLang": "en",
  "translationLang": "fr",
  "sources": [
    "こんにちは"
],
  "intermediations": [
    "Hello"
],
  "translations": [
    "Bonjour"
],
  "intermediationDetail": [
    {
      "source": "こんにちは",
      "translation": "Hello",
      "sentences": [
        {
          "source": "こんにちは",
          "sourcePosition": 0,
          "sourceLength": 5,
          "translation": "Hello",
          "translationPosition": 0,
          "translationLength": 5,
          "processType": "machineTranslation",
          "words": [
            {
              "source": "こんにちは",
              "sourcePosition": 0,
              "sourceLength": 5,
              "translation": "Hello",
              "translationPosition": 0,
              "translationLength": 5,
              "processType": "userDictionary",
              "udId": "default_for_ja_en"
}
],
          "sentences": [
            "入れ子の文章がある場合"
]
}
]
}
],
  "translationDetail": [
    {
      "source": "Hello",
      "translation": "Bonjour",
      "sentences": [
        {
          "source": "Hello",
          "sourcePosition": 0,
          "sourceLength": 5,
          "translation": "Bonjour",
          "translationPosition": 0,
          "translationLength": 7,
          "processType": "machineTranslation",
          "words": [
            {
              "source": "Hello",
              "sourcePosition": 0,
              "sourceLength": 5,
              "translation": "Bojour",
              "translationPosition": 0,
              "translationLength": 7,
              "processType": "userDictionary",
              "udId": "default_for_en_fr"
}
],
          "sentences": [
            "入れ子の文章がある場合"
]
}
]
}
]
}
```

--------------------------------

### POST /mt/v2/translate/details

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

Executes a translation request and returns detailed translation results including linguistic analysis.

```APIDOC
## POST /mt/v2/translate/details

### Description
Executes a translation request and returns detailed translation results including linguistic analysis.

### Method
POST

### Endpoint
https://{FQDN}/mt/v2/translate/details

### Parameters
#### Query Parameters
- **langFrom** (string) - Required - Source language code.
- **langTo** (string) - Required - Target language code.
- **profile** (string) - Required - Profile identifier.

#### Request Body
- **sources** (Array of strings) - Required - Array of source texts to translate.
- **udIds** (Array of strings) - Optional - Array of user dictionary IDs or aliases.
- **tmIds** (Array of strings) - Optional - Array of translation memory IDs or aliases.
- **user-options** (object) - Required - Translation options.
- **userLog** (string) - Optional - Custom string for server logs.
- **appId** (string) - Optional - Custom string for server logs.

### Request Example
{
  "sources": [
    "Who are you?",
    "Hello, I am MT."
  ],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
  ],
  "tmIds": [
    "translation-memory-1"
  ],
  "user-options": {
    "adaptPhrases": [
      { "source": "mirai translate", "target": "みらい翻訳" },
      { "source": "MT", "target": "みらい翻訳" }
    ],
    "concat": true,
    "jastyle": "j2k"
  }
}

### Response
#### Success Response (200)
- **sourceLang** (string) - Source language.
- **intermediationLang** (string) - Intermediation language.
- **translationLang** (string) - Target translation language.
- **sources** (Array) - Original source texts.
- **translations** (Array) - Translated texts.
- **translationDetail** (Array) - Detailed breakdown of the translation process.

#### Response Example
{
  "sourceLang": "ja",
  "translations": ["Bonjour"],
  "translationDetail": [
    {
      "source": "Hello",
      "translation": "Bonjour",
      "sentences": []
    }
  ]
}
```

--------------------------------

### Copyright Notice

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Legal notice regarding the copyright and usage restrictions of the API specification.

```text
æœ¬ä»•æ§˜ã®è‘—ä½œæ¨©ã¯æ ªå¼ä¼šç¤¾ã¿ã‚‰ã„ç¿»è¨³ã«å¸°å±žã™ã‚‹ã€‚
æ ªå¼ä¼šç¤¾ã¿ã‚‰ã„ç¿»è¨³ã«äº‹å‰ã®è¨±å¯ã‚’å¾—ãªã„é™ã‚Šã€æœ¬æ›¸ã«è¨˜è¼‰ã•ã‚Œã¦ã„ã‚‹æƒ…å ±ãŠã‚ˆã³è£½å“ã®å…¨éƒ¨ã¾ãŸã¯ä¸€éƒ¨ã«ã¤ã„ã¦ã€è»¢ç”¨ã‚ã‚‹ã„ã¯è¤‡è£½ã™ã‚‹ã“ã¨ã¯ã§ããªã„ã€‚
æœ¬æ›¸ã®æƒ…å ±ã¯åˆ©ç”¨è€…ã®ã¿ã«é–‹ç¤ºã™ã‚‹ã‚‚ã®ã§ã€ç¬¬3è€…ã«å¯¾ã™ã‚‹é…å¸ƒã«é–¢ã—ã¦ã¯æ ªå¼ä¼šç¤¾ã¿ã‚‰ã„ç¿»è¨³ã®æ‰¿èªãŒå¿…è¦ã¨ãªã‚‹ã€‚
```

--------------------------------

### 著作権表示

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

本仕様書の著作権および転用・複製に関する制限事項。

```text
本仕様の著作権は株式会社みらい翻訳に帰属する。
株式会社みらい翻訳に事前の許可を得ない限り、本書に記載されている情報および製品の全部または一部について、転用あるいは複製することはできない。
本書の情報は利用者のみに開示するもので、第3者に対する配布に関しては株式会社みらい翻訳の承認が必要となる。
```

--------------------------------

### POST /mt/v2/translate

Source: https://miraitranslate.com/miraipf-mt-api-v2-public

Submits source text to be translated and retrieves the translation results.

```APIDOC
## POST /mt/v2/translate

### Description
Translates the provided source text and returns the translation results.

### Method
POST

### Endpoint
https://{FQDN}/mt/v2/translate

### Parameters
#### Query Parameters
- **langFrom** (string) - Required - Source language code.
- **langTo** (string) - Required - Target language code.
- **profile** (string) - Required - Translation profile.

#### Request Body
- **sources** (Array of strings) - Required - Array of source text strings to translate.
- **udIds** (Array of strings) - Optional - Array of user dictionary IDs or alias names.
- **tmIds** (Array of strings) - Optional - Array of translation memory IDs or alias names.
- **user-options** (object) - Required - Translation options.

### Request Example
{
  "sources": [
    "Who are you? My name is john.",
    "Hello, I am MT."
  ],
  "udIds": [
    "user-dictionary-1",
    "user-dictionary-2"
  ],
  "tmIds": [
    "translation-memory-1"
  ],
  "user-options": {
    "adaptPhrases": [
      { "source": "mirai translate", "target": "みらい翻訳" },
      { "source": "MT", "target": "みらい翻訳" }
    ],
    "concat": true,
    "jastyle": "j2k"
  }
}

### Response
#### Success Response (200)
- **sourceLang** (string) - Source language code.
- **translationLang** (string) - Target language code.
- **sources** (Array of strings) - The original source text.
- **translations** (Array of strings) - The translated text results.

#### Response Example
{
  "sourceLang": "en",
  "translationLang": "ja",
  "sources": [
    "Who are you?",
    "Hello, I am MT."
  ],
  "translations": [
    "あなたは誰ですか？",
    "こんにちは、私はみらい翻訳です。"
  ]
}
```

--------------------------------

### Translation Response JSON Structure

Source: https://miraitranslate.com/miraipf-mt-api-v2-public/spec/api/openapi/miraipf-mt-api-v2-public.yml

Represents the successful response object containing source text, intermediate translations, and final target translations with detailed metadata.

```json
{
  "sourceLang": "ja",
  "intermediationLang": "en",
  "translationLang": "fr",
  "sources": [
    "こんにちは"
  ],
  "intermediations": [
    "Hello"
  ],
  "translations": [
    "Bonjour"
  ],
  "intermediationDetail": [
    {
      "source": "こんにちは",
      "translation": "Hello",
      "sentences": [
        {
          "source": "こんにちは",
          "sourcePosition": 0,
          "sourceLength": 5,
          "translation": "Hello",
          "translationPosition": 0,
          "translationLength": 5,
          "processType": "machineTranslation",
          "words": [
            {
              "source": "こんにちは",
              "sourcePosition": 0,
              "sourceLength": 5,
              "translation": "Hello",
              "translationPosition": 0,
              "translationLength": 5,
              "processType": "userDictionary",
              "udId": "default_for_ja_en"
            }
          ],
          "sentences": [
            "入れ子の文章がある場合"
          ]
        }
      ]
    }
  ],
  "translationDetail": [
    {
      "source": "Hello",
      "translation": "Bonjour",
      "sentences": [
        {
          "source": "Hello",
          "sourcePosition": 0,
          "sourceLength": 5,
          "translation": "Bonjour",
          "translationPosition": 0,
          "translationLength": 7,
          "processType": "machineTranslation",
          "words": [
            {
              "source": "Hello",
              "sourcePosition": 0,
              "sourceLength": 5,
              "translation": "Bojour",
              "translationPosition": 0,
              "translationLength": 7,
              "processType": "userDictionary",
              "udId": "default_for_en_fr"
            }
          ],
          "sentences": [
            "入れ子の文章がある場合"
          ]
        }
      ]
    }
  ]
}
```
Tokens:
Raw