Skip to main content
POST
Publish or schedule original project media to your own connected YouTube/TikTok channels, optionally with dynamic subtitles. This publishes externally; choose privacy explicitly when public access is intended.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: publishing:write, projects:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
required
Text value.Minimum length: 1. Maximum length: 200. Pattern: ^[^/\\]+$.
string
required
Text value.Minimum length: 1. Maximum length: 200. Pattern: ^[^/\\]+$.
string
required
Text value.Minimum length: 1. Maximum length: 100.
string
Text value.Maximum length: 5000.
array
List of values. See the complete input schema for its item structure.Maximum items: 20.
array
List of values. See the complete input schema for its item structure.Maximum items: 20.
string
Text value.Allowed values: “public”, “unlisted”, “private”. Default: “private”.
string
Text value.Allowed values: “PUBLIC_TO_EVERYONE”, “MUTUAL_FOLLOW_FRIENDS”, “FOLLOWER_OF_CREATOR”, “SELF_ONLY”. Default: “SELF_ONLY”.
boolean
Boolean value.Default: false.
string
Text value.Format: “date-time”. Pattern: ^(?:(?:\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
Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.Format: “uuid”. Pattern: ^[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}$.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

This operation returns HTTP 202 while running. Save requestId and poll action_request_get with that identifier and the original operation name. Polling states are running, completed, failed, and interrupted. A completed result can point to a separate media job; continue with the operation-specific status or output action. Returns the refreshed public original publication state after requesting publication or scheduling to selected channels.

Result fields

Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.
HTTP 200

Operation notes

  • This publishes externally and requires project ownership. At least one youtubeChannelIds or tiktokChannelIds array must contain a channel connected to the authenticated actor; each array allows at most 20 entries.
  • workId must belong to this project even though the selected media is the original video.
  • The integration defaults to youtubePrivacyStatus private and tiktokPrivacyLevel SELF_ONLY. Set the desired privacy explicitly when broader access is intended.
  • includeDynamicSubtitles defaults to false and requires subtitles:write when enabled. It uses normal subtitle allowances and media credits.
  • scheduledAt is an optional ISO datetime with an offset. Only a time strictly in the future schedules the original workflow; a valid past timestamp does not schedule it and may publish immediately.
  • This is a long-running action. Poll action_request_get for handler completion, then publishing_list for resource publication progress or scheduled results.
  • originalPublish may be null when no state is available, or show in-progress, scheduled, completed or failed state. Individual channel outcomes are in channels, so a returned result does not guarantee successful publication to every channel.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors