Skip to main content
POST
Publish or schedule a completed translation, lip-synced output or dynamic subtitle output to one of your own connected channels. The video URL comes from the selected stored version.

​
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: 200. Pattern: ^[^/\\]+$.
​
string
required
Text value.Allowed values: “youtube”, “tiktok”.
​
string
required
Text value.Minimum length: 1. Maximum length: 200. Pattern: ^[^/\\]+$.
​
string
Text value.Allowed values: “translated”, “lip-synced”, “dynamic-subtitles”. Default: “translated”.
​
string
required
Text value.Minimum length: 1. Maximum length: 100.
​
string
Text value.Maximum length: 5000.
​
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”.
​
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 either a scheduled publication identity and timestamp or an immediate published-video identity and URL.

​
Result fields

​
scheduledAt is omitted and the immediate publishing service resolves.

Returns the immediate publication attempt identity and platform video information.
HTTP 200

​
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. Select one channel belonging to the authenticated actor; accessible team project media does not grant access to another member’s channel.
  • videoSource defaults to translated. lip-synced selects the latest completed lip-sync video; dynamic-subtitles selects the stored dynamic-subtitle output. The version must be completed and the chosen output must exist.
  • The integration defaults to YouTube private and TikTok SELF_ONLY. The video URL comes from the authorized stored version, not a caller-supplied URL.
  • scheduledAt is optional. When supplied it must be a valid ISO datetime with an offset and strictly in the future; the handler returns its Unix-millisecond value. Without it, this action publishes immediately.
  • This is a long-running action. Poll action_request_get for the handler result and publishing_list for subsequent publication state. Scheduled and immediate responses have different fields.
  • The immediate handler reports status published with the social publishing service’s returned videoId and optional videoUrl. The queued schedule response has no videoId or videoUrl.
  • For TikTok, videoId may be the platform publication identifier when a final numeric video id is unavailable; videoUrl may fall back to the connected channel URL or stored source video.

​
Usage

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

​
Errors