文書目次

翻訳タスクAPI

翻訳タスクの作成

POST/v1/translation/create

文書・ファイル翻訳のための新しい翻訳タスクを作成します。

完全な住所
https://otranslator.com/api/v1/translation/create
認証
Authorizationリクエストヘッダーに API Key を渡す必要があります
Content-Type
multipart/form-data
誤った形式
{ "error": "Invalid API key." }

注意事項

タスクを作成すると、すぐに待機キューに入り、taskIdが返されます。その後、タスク照会インターフェースから進捗、費用、ダウンロードリンクを取得できます。

タスクを作成するには、アカウントのポイント残高が最低2 credits必要です。previewがtrueの場合、プレビューのみを生成し、プレビューのポイントを支払います。

glossary パラメータは用語集名で一致させ、複数の用語集を指定する際は同名のフィールドを複数回渡すことができます。

curl
1curl -X POST 'https://otranslator.com/api/v1/translation/create' \
2--header 'Authorization: [yourSecretKey]' \
3--form 'file=@bitcoin.pdf' \
4--form 'fromLang=English' \
5--form 'toLang=Simplified Chinese' \
6--form 'outputFormat=MD' \
7--form 'bilingualMode=Horizontal' 

リクエストパラメータ

パラメータタイプデフォルト説明
*filebinary-
  • 翻訳が必要なファイル
  • サポートファイル形式:照会
bitcoin.pdf
*fromLangString-
  • 原言語、原言語は対象言語と同じであってはなりません
  • サポート言語:照会
English
*toLangString-
  • 対象言語、対象言語は元の言語と同じにすることはできません
  • サポート言語:照会
Simplified Chinese
modelString-
  • 翻訳のAIモデル
  • サポートモデル:照会
-
fileDescriptionString-

文書説明。追加情報を提供することで翻訳品質を向上させます。例えば、文書の背景情報やその他の翻訳要件の追加など

-
glossaryString-

翻訳時に使用する用語集の名称

-
previewBooleanfalse

プレビューのみ生成するかどうか。プレビューのみ生成する場合、2クレジットをお支払いいただくことで文書翻訳のプレビューを生成します

-
shouldTranslateImageBooleanfalse
  • 文書内の画像を翻訳するかどうか
  • PDF / DOCX / PPTX / EPUB / ODS / ODT / ODFのみサポート
-
forceOCRBooleanfalse

OCRで文書内容を強制認識するかどうか。有効にすると画像翻訳も同時に有効になります。

-
shouldTranslateFileNameBooleantrue

ファイル名を翻訳するかどうか

-
strictSourceLanguageCheckBooleanfalse

原言語として認識されたテキストのみを翻訳するかどうか。有効にすると、原言語以外のコンテンツをより厳密にフィルタリングし、費用計算にもより厳格な係数を使用します。

-
outputFormatString-

出力形式。MDを渡すと、Markdown訳文の生成を試みます。

MD
bilingualModeStringHorizontal

対訳ファイルのレイアウト方向。Horizontalは左右配置、Verticalは上下配置を表します。

Horizontal
passwordString-

PDFファイルのオープンパスワード

-
ignoreCommentsBooleanfalse

DOCX、PPTX、XLSXのコメントを無視するかどうか

-
ignoreNotesBooleanfalse

PPTXのノートを無視するかどうか

-
ignoreHeadersAndFootersBooleanfalse

DOCXのフッターとヘッダーを無視するかどうか

-
ignoreHiddenBooleanfalse

PPTXの非表示スライドを無視するかどうか

-
ignoreMastersBooleanfalse

PPTXのマスターテキストを無視するかどうか

-
ignoreSheetNamesBooleanfalse

XLSXのシート名を翻訳しないかどうか

-
extractTextRegExpPatternString-
  • 正規表現にマッチするコンテンツのみを翻訳し、翻訳文に置き換えます
  • txmsgのみサポート
-
extractTextRegExpFlagsString-
  • 正規表現のFlags: g, s, m, u, y
  • txmsgのみサポート
-
allowFlipBooleantrue

RTL言語でページレイアウトを反転することを許可するかどうか。falseを渡すと画像の反転も同時にオフになります。

-
allowFlipImageBooleantrue

RTL言語で画像の内容を反転することを許可するかどうか。

-
webhookUrlString-

ステータス更新時のコールバックURL、コールバック内容に含まれるもの: {taskId, progress, status}

-

レスポンス

パラメータタイプデフォルト説明
taskIdString-

タスクID

-

よくあるエラー

401 Missing API key.

The Authorization request header is required.

401 Invalid API key.

The API key does not exist, has been deleted, or is no longer valid.

402 Insufficient credits balance.

The account does not have enough credits to create the task.

400 Missing required parameter: fromLang.

Provide fromLang using a language returned by /api/v1/languages.

400 Missing required parameter: toLang.

Provide toLang using a language returned by /api/v1/languages.

400 Invalid fromLang: [language]. Use a language returned by /api/v1/languages.

The provided source language is not supported.

400 Invalid toLang: [language]. Use a language returned by /api/v1/languages.

The provided target language is not supported.

400 Missing required file upload: file.

Upload the source document in the file form field.

404 Glossary "[name]" not found.

The specified glossary does not exist or does not belong to the current API account.

はじめに
開発者になる
翻訳タスクAPI
翻訳タスクの照会