Skip to main content
POST
Finalize your uploaded parts and receive the owned fileKey used by generation actions.

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: projects: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.Format: “uuid”. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
array
required
List of values. See the complete input schema for its item structure.Minimum items: 1. Maximum items: 10000.
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 completed owned fileKey and media read URL. Pass fileKey to the next generation or voice action.

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.
  • The upload prefix selects the required permission. tools uses transcription:write, subtitles uses subtitles:write, projects uses projects:write, and voices uses voices:write.
  • For tools, subtitles and projects, kind accepts transcription, video_to_srt, add_subtitles, animated_captions or project. The selected kind determines the workflow limits; the prefix does not force a kind.
  • The chosen kind applies its own limits: transcription 200 MiB; video_to_srt and add_subtitles 300 MiB; animated_captions 250 MiB and audio only; project uses the plan upload limit (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Standalone media is at most 2 hours. Captions allow 30 minutes on Beginner and 60 minutes on higher public plans, plus a 2-second container tolerance. Project duration is at most 2 hours, or 3 hours on Enterprise.
  • Submit every uploaded part exactly once with the ETag returned by its PUT. Parts are sorted by partNumber before finalization; ETags may include or omit surrounding quotes.
  • A successful completion removes the active session. Reuse the same requestId to recover its result after a response loss; do not submit a fresh completion against the consumed session.
  • Completing an upload does not consume a daily generation allowance. The separate generation determines media usage.

Usage

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

Errors