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.

このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は英語の原文もあわせてご確認ください。
Supertone APIには、公式にサポートされている2つのSDKが用意されています。REST APIをイディオマティックなクライアントでラップし、ストリーミングや長文の処理を肩代わりしてくれます。また、OpenAPI仕様と常に同期しています。

Python SDK

pip install supertone — 同期および非同期クライアント、並列自動チャンク分割。

TypeScript SDK

npm add @supertone/supertone — Promiseベース、ESM/CJS、NodeおよびBun対応。

​
パッケージ概要

PythonTypeScript
パッケージPyPIのsupertonenpmの@supertone/supertone
リポジトリsupertone-inc/supertone-pythonsupertone-inc/supertone-ts
言語Python 3.9+TypeScript 5+ / Node 18+
モジュール形式—ESM + CommonJS
認証Supertone(api_key=...)new Supertone({ apiKey: ... })
同期APIあり（デフォルト）n/a
非同期API*_asyncメソッド + async withすべてのメソッド（Promise）
ストリーミングiter_bytes() / aiter_bytes()ReadableStreamリーダー
長文の自動チャンク分割✅（300文字、最大3ワーカーで並列）✅（300文字、逐次）
カスタムリトライ✅ retry_config経由✅ retryConfig経由
HTTPバックエンドhttpxfetch

​
SDKが代行してくれること

  • 認証 — コンストラクション時に一度API Keyを渡せば、すべてのリクエストに適切なヘッダーが付加されます。
  • 言語、モデル、出力形式の型安全なenum。
  • ストリーミング — オーディオチャンクをイディオマティックに反復処理できます（Pythonジェネレータ、TSのReadableStream）。
  • 長文の自動チャンク分割 — 両SDKは入力を300文字で分割し、チャンクごとにTTSを実行してオーディオを結合します。ストリーミング系のメソッドはチャンクを透過的に転送するため、利用者はリクエストが内部で分割されていることを意識する必要がありません。
  • エラー — HTTPステータスコードに対応した型付き例外/エラークラス（UnauthorizedErrorResponse、TooManyRequestsErrorResponseなど）。
  • リトライポリシー — 一時的な5xxおよび429レスポンスに対する、バックオフ付きの設定可能なリトライ。

​
REST APIを直接使う場合

REST APIは、SDKが提供されていない言語やランタイム（Go、Java、PHP、Rust、組み込みシステムなど）、またはワイヤフォーマットを最大限にコントロールしたい場合に使用できます。各エンドポイントはAPIリファレンスに記載されており、そのセクションのサンプルにはcurl、JavaScript、Go、Python、PHP、Javaが含まれています。 REST APIを直接呼び出す場合は、チャンク分割、リトライ、ストリーミングの消費を自前で実装する必要があります。

​
次のステップ

Python SDK

インストール、認証、最初の呼び出しまで。

TypeScript SDK

インストール、認証、最初の呼び出しまで。