Skip to main content
POST
アップロード済みの音声または動画から、編集可能な SRT 字幕を作成します。必要に応じて字幕レイアウトを設定できます。簡潔な保存済み結果の参照を返します。完全な出力は、その getAction または downloadAction で取得してください。

認証と権限

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

パラメーター

string
必須
completed のアップロードまたはメディアインポートが返す、所有する fileKey。生成のたびにアップロード済みソースが消費されます。最小文字数: 1. 最大文字数: 1024.
string
テキスト値。最小文字数: 1. 最大文字数: 255. パターン: ^[^/\\\r\n\0]+$.
array
値のリスト。要素の構造は完全な入力スキーマを参照してください。最大要素数: 100.
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}$.
object
JSON オブジェクト。ネストされたフィールドは完全な入力スキーマを参照してください。
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

冪等性

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

リクエスト例

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

レスポンス

この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action_request_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。 保存済み字幕結果への参照。完全な JSON には srt、sourceSrt、layoutOptions、styleOptions、および任意の detectedLanguage、historyId、revision、updatedAt が含まれます。

結果フィールド

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

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

操作の注意事項

  • 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
  • 成功したアクションは、API/MCP 共通の月間呼び出し枠を1回消費します。月間上限は Beginner が 500 回、Starter が 5,000 回、Creator が 25,000 回で、Pro、Scale、Enterprise に月間上限はありません。毎分の上限はそれぞれ 30、60、120、180、300、600 回で、引き続き適用されます。ツールの生成枠は別です。
  • UUID v4 の requestId、またはそれと同じ値の Idempotency-Key ヘッダーを使用し、再試行時もアクション、ID、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
  • このアクションは非同期です。最初のトランスポート結果は pollAction を含む running 状態のリクエストです。この操作名と元の requestId を指定して action_request_get をポーリングしてください。ここに示す完了時の操作結果は、生成本文ではなく、保存済み出力への簡潔な参照です。
  • 完全な出力は、認証済みの所有者情報に紐づけて暗号化ストレージに保存され、保持量に制限のあるアクションポーリングキャッシュとは独立しています。構造化JSONを取得するには、返された getAction に resultId と includeContent: true を渡してください。JSONテキストを取得するには、downloadAction に resultId を渡します。元のリクエストのみが分かる場合は、listAction で復旧できます。
  • 保存済み JSON の上限は 32 MiB です。メタデータがストレージの暗号化キーや、認証不要の文字起こしダウンロード URL を公開することはありません。
  • 生成が成功すると、個人用ツールの利用枠を1回分使用確定します。生成が失敗した場合、通常はツールの予約枠を解放します。出力が永続保存されたか不明な場合は、再生成する前に同じリクエストと保存済み結果の履歴を確認してください。重複利用を防ぐため、サーバーは予約を保持します。
  • 月間の連携上限がない上位プランにも、以下のツール別の日次利用枠とメディア上限は適用されます。これらの単体アクションは、吹き替え分数や TTS 文字数ではなく、各ツールの利用枠を消費します。
  • ご自身が所有する完了済みアップロードまたはインポートの fileKey を使用し、一度限りの使用として扱ってください。メディア処理の開始後は、成功した場合も処理に失敗した場合も、クリーンアップで元ファイルが削除されます。処理前に検証または利用枠の確認で拒否された場合は、元ファイルが残ることがあります。別の生成を開始する前に、元の requestId を再利用して受け付け済みの生成を復旧してください。
  • 対応する音声または動画を 300 MiB・2時間まで受け付けます。subtitleLayout には maxLinesPerCaption(1、2、3)と maxCharactersPerLine(24~64)の両方が必要です。デフォルトは 2 と 42 です。
  • ツールごとの1日の利用枠は、生成成功回数で Beginner 5、Starter 15、Creator 30、Pro 60、Scale 100、Enterprise 100です。対応するWebツールと共有され、アカウントのツールのリセット期間を使用します。
  • srt はレイアウトに合わせて整形されたテキストで、sourceSrt は生成時のソースを保持します。historyId、revision、updatedAt は、編集可能な字幕履歴の保存に成功した場合のみ存在します。更新前に最新リビジョンを読み取ってください。

使用量

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

エラー