Skip to main content
POST
直接アクセスできる公開 HTTPS 音声・動画 URL をアカウントにインポートします。リダイレクトとプライベートネットワークは拒否され、ファイルと長さの制限が適用されます。生成アクションでは、返された fileKey を使用してください。

認証と権限

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

パラメーター

string
必須
テキスト値。最大文字数: 4096. 形式: “uri”.
string
テキスト値。最小文字数: 1. 最大文字数: 255. パターン: ^[^/\\\r\n\0]+$.
string
必須
テキスト値。許容値: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.
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}$.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

冪等性

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

リクエスト例

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

レスポンス

この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action_request_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。 インポート済みの、実行者が所有するメディア参照。サイズ、長さ、メディアの種類、読み取りURLが検証済みです。これはポーリング後の、完了したアクションの出力です。

結果フィールド

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

接続が切断された後も同じ識別子を使用してください。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、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
  • アップロードのプレフィックスによって必要な権限が決まります。tools は transcription:write、subtitles は subtitles:write、projects は projects:write、voices は voices:write を使用します。
  • ツール、字幕、プロジェクトでは、kind は transcription、video_to_srt、add_subtitles、animated_captions、project を受け付けます。選択した kind によってワークフローの上限が決まり、プレフィックスが kind を強制することはありません。
  • 選択した kind ごとに上限が適用されます。transcription は 200 MiB、video_to_srt と add_subtitles は 300 MiB、animated_captions は 250 MiB で音声のみ、project はプランのアップロード上限(Beginner 5 GiB、Starter 10 GiB、Creator 20 GiB、Pro 30 GiB、Scale 40 GiB、Enterprise 60 GiB)を使用します。単体ツールのメディアは最大2時間です。字幕はBeginnerで30分、上位の公開プランで60分までで、コンテナには2秒の許容幅があります。プロジェクトの長さは最大2時間、Enterpriseでは3時間です。
  • このアクションは非同期で実行されます。操作名と元の requestId を指定して、完了するまで action_request_get をポーリングしてから、結果の fileKey を取得してください。
  • 公開 HTTPS 音声/動画ファイルへの直接 URL を使用してください。リダイレクト、認証情報、フラグメント、443 以外のポート、非公開の DNS アドレスは拒否されます。YouTube の視聴ページは直接メディア URL ではありません。専用の YouTube アクションを使用してください。
  • URL パスの末尾が対応するメディアファイル名の場合、filename は任意です。保存時のファイル名はサニタイズされます。サーバーは fileKey を返す前に、実際の長さを解析します。
  • インポートはメディアを準備し、月間連携呼び出しの成功回数を1回消費します。ツールの1日あたりの生成枠は、その後の生成時にのみ消費されます。

使用量

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

エラー