Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supertoneapi.com/llms.txt

Use this file to discover all available pages before exploring further.

このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は英語の原文もあわせてご確認ください。

開始について

開発者コンソールでサインアップし、新しいキーを作成してください。アカウントにつき最大3つのキーを発行でき、いつでも廃棄・再発行が可能です。
すべてのリクエストにx-sup-api-key: [YOUR_API_KEY]ヘッダーを含めてください。両方のSDKはコンストラクタでキーを受け取ります。詳しくは認証をご覧ください。
いいえ。APIとSupertone Playは同じアカウント、クレジット残高、ボイスライブラリを共有します。
公式SDKは2つあります。Python(PyPIでsupertone)とTypeScript(npmで@supertone/supertone)です。その他の言語については、REST APIを直接呼び出してください。

ボイスとTTS呼び出し

3つの方法があります。(1) Supertone Playのボイスカードからコピー、(2) GET /v1/voicesを呼び出す、(3) GET /v1/voices/searchでフィルタリングする。詳しくはボイスをご覧ください。
はい。Playでクローンしたボイスは、同じアカウント上で即座にAPIから利用可能です。同様に、POST /v1/custom-voices/cloned-voice経由で作成したボイスはPlayにも表示されます。同期の手順は不要です。
カスタム(クローン)ボイスは、作成したアカウントからのみ呼び出すことができます。別のアカウントのキーを使用している場合、APIは403 Forbiddenを返します。
ボイスオブジェクトのsamplesフィールドに、サポートされているすべての(language, style, model)の組み合わせと、それぞれのプレビューURLが記載されています。TTSリクエストを送信する前に確認してください。
いいえ。styleを省略した場合、ボイスのstyles配列の最初の値がデフォルトとして使用されます。
はい。Voice settingsを参照してください。モデルによってサポートされるパラメータは異なります。サポートされていない設定は黙って無視されます。
生のAPIはtext300文字に制限しています。PythonとTypeScriptのSDKは長いテキストを自動チャンク分割して音声をマージします。詳しくは長文をご覧ください。
指定されたテキストに対する生成音声の予測される長さを返します — クレジットは消費しません。コストプレビューやUIのヒントに有用です。詳しくはPredict durationをご覧ください。

クレジットと料金

クレジットは生成された音声の秒数単位で差し引かれます。料金はPlayと同じクレジットシステムを使用しており、Play購読ページでクレジットを購入できます。
2つの方法があります。(1) GET /v1/credits(またはSDKのget_credit_balance)を呼び出す、(2) コンソールまたはPlayのダッシュボードを確認する。
はい。同じ残高が両方に適用されます。クローンボイスの呼び出しも、プリセットボイスと同じ方法でクレジットを差し引きます。

エラーとトラブルシューティング

  • 401 — API Keyの欠落または無効
  • 402 — クレジット不足
  • 403 — このアカウントが所有していないボイス
  • 400 — リクエストボディの問題(フィールド欠落、無効なenum、生のAPIで300文字超過のtext)
  • 429 — レート制限超過
詳しいリファレンスはエラー処理をご覧ください。
順番に確認してください。
  1. x-sup-api-keyヘッダーが、先頭/末尾に空白なく設定されているか。
  2. POSTリクエストにContent-Type: application/jsonがあるか。
  3. voice_idがこのアカウントの実在するIDか(GET /v1/voicesまたはGET /v1/custom-voicesを呼び出して確認)。
  4. textlanguagestyleがそのボイスのサポート内容と一致しているか。
問題が続く場合は、リクエストボディ、ヘッダー、発生時刻を添えてサポートにお問い合わせください。
デフォルトはティア別に1分あたり20 / 30 / 60リクエストです。ボイスクローンは1分あたり10回です。詳しくはレート制限をご覧ください。

運用

はい。コンソールでサインアップすればすぐに使用できます。承認手続きはありません。
はい。チーム単位の利用、より高いレート制限、サブユーザーアカウント、専用容量については、エンタープライズお問い合わせからお問い合わせください。
カスタマーサポートで1:1お問い合わせを送信してください。リクエストペイロード、ヘッダー、タイムスタンプを含めると、迅速な解決につながります。