Skip to main content
POST
Get an owned speech creation, including its script, delivery settings, temporary audio URL, and available word alignment.

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: tts:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
required
History ID returned by tts_generate or tts_list.Pattern: ^(free-)?[0-9a-f]{64}$.
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. Owned speech history detail, full editable and spoken scripts, delivery settings, temporary playback URL, and any available word timestamps.

Result fields

Operation notes

  • historyId must be 64 lowercase hexadecimal characters, optionally prefixed with free-. Use the identifier returned by tts_generate or tts_list.
  • Optional older-record properties such as voiceName, voiceSource, and sourceFileName can be omitted. Missing instructions defaults to an empty string, missing speed to 1, and missing previewEndIndex to null.
  • wordAlignment can be null. This read loads existing alignment; use tts_align to prepare timestamps.
  • Source character indices in wordAlignment refer to spokenText, which has delivery control tags removed.
  • audioUrl is temporary. Call tts_get again for fresh playback or tts_download for a download link.
  • Speech history and custom voices belong to the authenticated account. Team billing does not grant access to another member’s speech or voices.

Usage

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

Errors