Skip to main content
POST
Queue speech regeneration for a segment, optionally refresh its lip sync, and use the normal media credits. requestId must be a stable UUID. Poll segment_actions_list.

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: translations:write. 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: ^[^/\\]+$.
integer
required
Integer value.Minimum: 0. Maximum: 9007199254740991.
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}$.
string
Text value.Maximum length: 500.
boolean
Boolean value.
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

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Returns queue admission for regeneration of one segment in an authorized translated version.

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

  • Use one UUID v4 requestId for the intended edit and reuse it with identical arguments on retries. jobId equals this requestId.
  • Admission returns started or queued, not completion. Poll segment_actions_list and find items[].id equal to jobId until completed, failed, or cancelled, then refresh transcripts_get and projects_get.
  • queue.revision tracks queue state; it is not a source segment structure revision. Queue actions capture the current structure when admitted. A later incompatible structure change can fail the item with SEGMENT_STRUCTURE_CHANGED.
  • Only one pending action for the same logical segment target is admitted. A new requestId does not bypass SEGMENT_ACTION_ALREADY_PENDING.
  • Queue execution failures appear as items[].status failed plus errorCode, rather than changing the successful submission result.
  • workId and translatedVersionId must belong to the selected project and to each other. The worker evaluates current media, segment state, permissions and credits when execution begins.
  • segmentTranslationInstructions is optional and limited to 500 characters. regenerateLipSync true requests segment lip-sync regeneration after speech, using that version’s last lip-sync mode.
  • Normal media credits apply. A successful admission does not mean that regeneration or optional lip sync has succeeded.
  • After the queue item completes, refresh projects_get and transcripts_get; the response itself has no new audio or video URL.
  • Queue responses, including submission, cancellation, polling and replay, contain action metadata only. Read transcript content with transcripts_get and the required transcription:read permission.

Usage

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

Errors