Skip to main content
POST
プロジェクトの元メディアを、ご自身が接続した YouTube/TikTok チャンネルで公開または公開予約します。必要に応じて動的字幕を追加できます。外部に公開されるため、一般公開を意図する場合はプライバシー設定を明示的に選択してください。

認証と権限

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

パラメーター

string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.
string
必須
テキスト値。最小文字数: 1. 最大文字数: 100.
string
テキスト値。最大文字数: 5000.
array
値のリスト。要素の構造は完全な入力スキーマを参照してください。最大要素数: 20.
array
値のリスト。要素の構造は完全な入力スキーマを参照してください。最大要素数: 20.
string
テキスト値。許容値: “public”, “unlisted”, “private”. デフォルト値: “private”.
string
テキスト値。許容値: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. デフォルト値: “SELF_ONLY”.
boolean
真偽値。デフォルト値: false.
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 です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。 選択したチャネルへの公開または公開予約をリクエストし、更新後の元動画の公開状態を公開用の形式で返します。

結果フィールド

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

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

操作の注意事項

  • 外部への公開を行うため、プロジェクトの所有権が必要です。youtubeChannelIds または tiktokChannelIds の少なくとも一方に、認証済みの実行者が接続したチャネルを含める必要があります。各配列の上限は20件です。
  • 選択したメディアが元動画であっても、workId はこのプロジェクトに属している必要があります。
  • この連携では、youtubePrivacyStatus のデフォルトが private、tiktokPrivacyLevel のデフォルトが SELF_ONLY です。より広い範囲に公開する場合は、必要な公開範囲を明示的に設定してください。
  • includeDynamicSubtitles のデフォルトは false で、有効にするには subtitles:write が必要です。通常の字幕利用枠とメディアクレジットを使用します。
  • scheduledAt は任意のオフセット付き ISO 日時です。現在より後の時刻のみが元メディアのワークフローを予約します。有効な過去のタイムスタンプは予約にならず、即時公開される場合があります。
  • これは長時間実行アクションです。action_request_get でハンドラーの完了をポーリングし、その後 publishing_list でリソースの公開進行状況や予約結果を取得してください。
  • originalPublish は、状態がない場合は null、それ以外は in-progress、scheduled、completed、failed の状態を示します。チャンネルごとの結果は channels に含まれるため、結果が返されても、すべてのチャンネルへの公開成功は保証されません。

使用量

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

エラー