Skip to main content
POST
Update saved SRT and layout using its latest revision. A stale revision is rejected so concurrent edits cannot overwrite one another.

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: subtitles: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: 160. Pattern: ^[A-Za-z0-9_-]+$.
string
required
Text value.Minimum length: 1. Maximum length: 2097152.
integer
required
Integer value.Maximum: 9007199254740991.
object
JSON object. See the complete input schema for its nested fields.
object
JSON object. See the complete input schema for its nested fields.
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

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. The same editable subtitle history ID with its incremented revision, update timestamp and normalized current SRT.

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

  • Requires a paid subscription and the action permission. The actor’s personal tool plan is rechecked at execution; saved tools and upload references belong to that actor, including when the credential is associated with a team.
  • A successful action uses one shared monthly API/MCP call. Beginner allows 500, Starter 5,000 and Creator 25,000 calls/month; Pro, Scale and Enterprise have no monthly ceiling. Per-minute limits still apply: 30, 60, 120, 180, 300 and 600 respectively. Tool generation allowances are separate.
  • Use a UUID v4 requestId, or an identical Idempotency-Key header, and retain the same action, ID and arguments on retries. A cached replay does not use another monthly call.
  • Read subtitles_history_get first, then pass its revision as expectedRevision. A stale revision returns VIDEO_TO_SRT_HISTORY_CONFLICT and cannot overwrite another edit.
  • SRT cues are parsed, sorted and normalized; they must not overlap or exceed the source media duration plus 0.5 seconds. Input is bounded to 2 MiB of UTF-8 SRT.
  • Omitted layoutOptions and styleOptions are normalized to the standard defaults (2 lines, 42 characters, sans/medium/white/outline/bottom), rather than implicitly preserving prior custom values. Include both when retaining customized formatting.
  • This edits text and formatting in saved SRT history. It does not render a new video, transcribe again, consume a media upload or use another daily generation allowance.

Usage

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

Errors