Skip to main content
POST
アップロード済みの fileKey からプロジェクトを作成し、文字起こしと翻訳を行った後、音声を合成します。独自の SRT、音声、字幕、任意のリップシンクに対応します。通常のメディア用クレジットを使用します。任意の webhookUrl で処理イベントを受信できます。projects_status で状態を確認してください。

​
認証と権限

​
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: projects:write, translations:write, transcription:write. 有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

​
パラメーター

​
string
必須
テキスト値。最小文字数: 1. 最大文字数: 1024.
​
string
必須
テキスト値。許容値: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
​
string
テキスト値。許容値: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
​
string
テキスト値。最小文字数: 1. 最大文字数: 200.
​
string
テキスト値。許容値: “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “16”, “17”, “18”, “19”, “20”, “21”, “22”, “23”, “24”, “25”, “26”, “27”, “28”, “29”, “30”, “31”, “32”, “auto-detect”.
​
array
値のリスト。要素の構造は完全な入力スキーマを参照してください。最大要素数: 1000.
​
boolean
真偽値。
​
string
テキスト値。最大文字数: 1000000.
​
string
テキスト値。最大文字数: 2048. 形式: “uri”.
​
string
トランスポート境界では任意です。省略すると、検証前にサーバーが識別子を補完します。レスポンスを受信できなかった場合に安全に復旧できるよう、固定の UUID v4 を指定してください。形式: “uuid”. パターン: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
​
boolean
真偽値。
​
boolean
真偽値。
​
number
数値。最小値: 1. 最大値: 70.
​
string
テキスト値。許容値: “cloning”, “custom”.
​
string
テキスト値。最小文字数: 1. 最大文字数: 128.
​
boolean
真偽値。
​
string
テキスト値。許容値: “translated”, “original”.
​
string
テキスト値。許容値: “studio”, “realistic”.
​
string
テキスト値。許容値: “standard”, “pro”, “studio”.
​
boolean
真偽値。
​
object
JSON オブジェクト。ネストされたフィールドは完全な入力スキーマを参照してください。
​
array
値のリスト。要素の構造は完全な入力スキーマを参照してください。最大要素数: 100.
​
string
テキスト値。最大文字数: 1000000.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

​
冪等性

変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。 すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。

​
リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

​
レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 文字起こしに続く翻訳・音声生成、または指定済み翻訳による吹き替えを開始した後、新しいプロジェクト識別子を返します。

​
結果フィールド

​
translatedSrt が指定され、受け付けられています。

同じ結果フィールドで、指定された対象テキストの吹き替えが受け付けられたことを示します。
HTTP 200

​
リクエストの復旧とポーリング

接続が切断された後も同じ識別子を使用してください。resultStored が false の場合は、対応する履歴、結果、またはダウンロードアクションで出力を取得します。進捗を確認するためだけに、別の生成を開始しないでください。
HTTP 200

​
操作の注意事項

  • 完了済みの fileKey は認証済み実行者に属している必要があります。サーバーが保存済みメディアの長さとサイズを計測します。
  • 任意の sourceSrt を指定する場合は、originalLanguage の明示が必要です。translatedSrt も指定する場合、両方の SRT のキュー数は同じである必要があり、指定した翻訳はキューのインデックスで対応付けられます。
  • translatedSrt を指定すると、ワークフローはそのテキストを吹き替え、指定済み翻訳の受け付け確認を返します。sourceSrt がある場合はインデックスでキューを対応付け、ない場合は自動文字起こしのタイムラインを使用します。
  • 作成結果に workId や translatedVersionId は含まれません。生成された後に projects_status または projects_get から取得してください。
  • voiceMode の既定値は cloning です。voiceMode custom では、カタログの音声、または認証済みアカウントが保存したカスタム音声を使用し、voiceCloningSettings は指定しないでください。チームでの請求によって他のメンバーの保存済み音声にアクセスできるようにはなりません。
  • 任意の subtitles、lipSyncMode、translationTimeSkips には動画入力が必要です。スキップ範囲はメディアの長さの範囲内で、keepBackgroundMusic は true、keepOriginalVoice は false である必要があります。
  • lipSyncMode は standard、pro、studio を受け付け、プランと通常のメディアクレジット確認が適用されます。月間 API 呼び出しが無制限でも、音声生成やリップシンクが無料になるわけではありません。
  • メディア処理の状態は projects_status をポーリングし、全言語のバージョンは projects_get で取得してください。
  • originalLanguage には fr や en などの元言語コード（対応する場合は auto-detect）を指定します。targetLanguage には english などの対応する翻訳先言語名を指定します。

​
使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

​
エラー