Skip to main content
POST
Export saved transcription text as raw text, paragraphs or sentences.

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.Minimum length: 1. Maximum length: 160. Pattern: ^[A-Za-z0-9_-]+$.
string
Text value.Allowed values: “raw”, “paragraphs”, “sentences”. Default: “paragraphs”.
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. Exported saved transcript text, with a sanitized .txt filename and text MIME type.

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.
  • format accepts raw, paragraphs or sentences and defaults to paragraphs. Content is taken from the matching saved transcript variant.
  • Returns text inside JSON. Save the content string to the returned fileName; this action does not return binary media or a public transcript URL.
  • The output filename is sanitized from the saved source name and bounded to a 180-character basename. Export reads existing history and does not consume a source upload or daily tool allowance.

Usage

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

Errors