Skip to main content
POST
ご自身が所有する生成音声を、台本、読み上げ設定、一時的な音声 URL、利用可能な単語アラインメントとともに取得します。

認証と権限

string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: tts:read. 有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

パラメーター

string
必須
tts_generate または tts_list が返す履歴ID。パターン: ^(free-)?[0-9a-f]{64}$.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 所有する音声履歴の詳細、編集可能な原稿と読み上げ原稿の全文、読み上げ設定、一時再生 URL、および取得可能な単語タイムスタンプ。

結果フィールド

操作の注意事項

  • historyId は 64 文字の小文字16進数で、任意で free- を先頭に付けられます。tts_generate または tts_list が返した識別子を使用してください。
  • voiceName、voiceSource、sourceFileName など、古いレコードの任意プロパティは省略される場合があります。instructions がない場合は空文字列、speed は 1、previewEndIndex は null がデフォルトです。
  • wordAlignment は null の場合があります。この読み取りは既存のアラインメントを読み込みます。タイムスタンプの準備には tts_align を使用してください。
  • wordAlignment の元文字インデックスは、読み上げ制御タグを除去した spokenText を参照します。
  • audioUrl は一時 URL です。新しい再生 URL は tts_get を再度呼び出し、ダウンロードリンクは tts_download で取得してください。
  • 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。

使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

エラー