Skip to main content
POST
Merge a source segment into the following segment and coordinate every translated work. Supply the current segmentStructureRevision; the retained segment needs speech regeneration.

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: transcription: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: ^[^/\\]+$.
integer
required
Integer value.Minimum: 0. Maximum: 9007199254740991.
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}$.
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 the updated source structure summary after merging the selected segment with its immediate following segment.

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

  • Read the latest projects_get.segmentStructureRevision and pass it as expectedSegmentStructureRevision. Queue revision is a different counter.
  • Merges segmentIndex and segmentIndex + 1, retaining the selected first index and source-timeline boundaries. All translated works are coordinated and following indexes are reindexed.
  • A source gap greater than 2 seconds requires confirmLargeGap true after an explicit caller decision. A merged span cannot overlap a translation time skip.
  • The merged segment needs speech regeneration. Refresh transcripts_get and translations_get, then queue segments_regenerate for an appropriate completed version.
  • This returns a structure summary only. It does not return newly generated media or a queued job.

Usage

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

Errors