Skip to main content
POST
完了した翻訳版、リップシンク出力、または動的字幕出力を、ご自身が接続したチャンネルで公開または公開予約します。動画 URL には、選択した保存済みバージョンの URL が使用されます。

認証と権限

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

パラメーター

string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
必須
テキスト値。許容値: “youtube”, “tiktok”.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
テキスト値。許容値: “translated”, “lip-synced”, “dynamic-subtitles”. デフォルト値: “translated”.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 100.
string
テキスト値。最大文字数: 5000.
string
テキスト値。許容値: “public”, “unlisted”, “private”. デフォルト値: “private”.
string
テキスト値。許容値: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. デフォルト値: “SELF_ONLY”.
string
テキスト値。形式: “date-time”. パターン: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$.
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 を返します。

結果フィールド

scheduledAt は省略され、即時公開サービスの処理が完了します。

即時公開試行の識別情報と、プラットフォーム上の動画情報を返します。
HTTP 200

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

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

操作の注意事項

  • 外部への公開を行います。認証済み実行者が所有するチャンネルを1つ選択してください。チームのプロジェクトメディアにアクセスできても、他のメンバーのチャンネルへのアクセス権は付与されません。
  • videoSource のデフォルトは translated です。lip-synced は最後に完了したリップシンク動画、dynamic-subtitles は保存済みの動的字幕出力を選択します。バージョンは completed で、選択した出力が存在する必要があります。
  • 連携でのデフォルトはYouTubeが private、TikTokが SELF_ONLY です。動画URLはアクセスが許可された保存済みバージョンから取得し、呼び出し側が指定したURLは使用しません。
  • scheduledAt は省略可能です。指定する場合は、オフセット付きの有効な ISO 日時で、現在より未来である必要があります。ハンドラーはその値を Unix 時間のミリ秒単位で返します。省略すると、このアクションは直ちに公開します。
  • このアクションは完了まで時間がかかります。ハンドラーの結果は action_request_get、その後の公開状態は publishing_list をポーリングしてください。予約公開と即時公開ではレスポンスのフィールドが異なります。
  • 即時実行のハンドラーは、ソーシャル公開サービスが返す videoId と任意の videoUrl とともに、status published を返します。queued の予約レスポンスには videoId も videoUrl も含まれません。
  • TikTok では、最終的な数値の動画 ID を取得できない場合、videoId はプラットフォームの公開識別子になることがあります。videoUrl は接続済みチャンネルの URL または保存済みの元動画にフォールバックすることがあります。

使用量

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

エラー