Skip to main content
POST
Read metadata for your saved output. Set includeContent=true to retrieve the complete structured JSON, including all caption words or transcript text.

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: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.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)$.
boolean
Boolean value.Default: false.
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.

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. Saved output metadata, plus the complete structured result when includeContent is true. Omitting includeContent returns metadata only.

Result fields

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.
  • resultId is a UUID from a completed generation reference or this domain’s result_list. It is different from the action requestId and web-tool historyId.
  • Results are owned by the authenticated actor and permission domain. A subtitles result cannot be read through transcription actions, or the reverse.
  • Complete saved JSON is encrypted at rest and retained independently of the bounded action polling cache. Retrieval remains authenticated; no public transcript or caption JSON URL is issued.
  • These actions retrieve existing output and do not generate media or use a daily allowance. Each successful retrieval still uses one monthly integration call.
  • Pending metadata means output persistence needs recovery. Reading content or downloading attempts recovery of an already saved encrypted object; check it before starting another generation.
  • includeContent defaults to false. true decrypts and returns the complete generated JSON under result. This example shows the content-returning form.
  • The nested result shape follows its original operation. Transcription outputs contain transcript text, subtitle outputs can contain SRT/rendered-video data, and captions contain word text, startMs/endMs, nullable speakerId and durationSeconds.

Usage

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

Errors