SpeechdashHelp Center

API の概要

自社のアプリケーションから Speechdash を呼び出し、認証に使用する API キーを作成します。

Speechdash API を使用すると、アプリケーションと同じボイスでドキュメントを作成し、音声合成を行うことができます。API を通じて作成したものはすべて、ライブラリに表示されます。アプリ内で完了したオーディオおよびビデオのトランスクリプトは、ライブラリのドキュメントとして表示されます(sourcetranscription で、transcript_id が含まれます)。/transcripts の REST リソースは存在しません。ドキュメントのエンドポイントを使用してください。API はトランスクリプションのジョブを開始しません。

ベース URL:

https://api.speechdash.com/v1

ヘルスチェック(API キーなし):GET https://api.speechdash.com/health

機械可読の契約書は https://api.speechdash.com/v1/openapi.json に公開されており、自社の言語向けのクライアントを生成できます。

エンドポイント

メソッドパス目的
GET/healthサービスのヘルスチェック(/v1 の下ではない)
GET/v1/openapi.jsonOpenAPI 3.1 ドキュメント
GET/v1/meアカウント、プラン、およびウォレット
GET/v1/documentsライブラリのドキュメント一覧(完了したトランスクリプトを含む)
POST/v1/documentsテキストドキュメントを作成(source=api
GET/v1/documents/{document_id}ドキュメントとそのテキストを読み込み
PUT/v1/documents/{document_id}タイトル、テキスト、言語、is_archived、または visibility を更新
DELETE/v1/documents/{document_id}ドキュメントを削除
POST/v1/documents/{document_id}/translate新しい翻訳版(MP3 エクスポートと同じクレジット)
GET/v1/documents/{document_id}/exportpdfdocxtxtcsvsrt、または vtt をダウンロード
POST/v1/audio/speech最大5,000文字の音声合成(JSON + オーディオ)
POST/v1/audio/streamWAV をストリーミング(最大20,000文字)
POST/v1/audio/stream/with-timestampsセンテンスごとの音声とマーク付きの SSE
GET/v1/voicesボイスカタログ
GET/v1/voices/{voice_id}1つのボイスプリセット

インタラクティブな OpenAPI ページ: アカウント, ドキュメント, オーディオ, ボイス

MCP サーバー(AI アシスタント用)

Cursor、Claude Desktop、または他の MCP クライアントを使用している場合は、公式の Speechdash MCP サーバー を追加することで、HTTP を直接呼び出す代わりに使用できます。これは、同じライブラリ(完了したトランスクリプトを含む)、翻訳、エクスポート、ボイス、アカウントのスナップショット、およびストリーミング以外の音声合成を、同じ API キーと請求設定で提供するツールを公開します。ストリーミング音声は REST にとどまります。

MCP サーバーの フルツール一覧とセットアップ(stdio または Streamable HTTP)をご覧ください。また、AI システム向けの機械可読ドキュメントが掲載されている Agents hub もご覧ください。エンドユーザーは、このヘルプセンターの API キーと MCP から始めることができます。

API キーの作成

設定 → API を開きます。

新規キー をクリックし、使用場所を示す名前(例: Production server)を付けます。

キーをすぐにコピーしてください。保存されるのはプレフィックスのみですので、一度だけ表示され、その後は表示されません。

キーはアカウントに影響を与えます。サーバー上に保管し、ブラウザ、モバイルアプリ、または公開リポジトリに決して保存しないでください。キーが漏洩した場合は、設定 → API から無効化し、新しいキーを作成してください。

最大10個のアクティブなキーを保持でき、いつでも名前を変更でき、各キーの最後の使用日時を確認できます。キーを無効化すると、そのキーによるリクエストは即座に停止します。

リクエストの認証

キーをベアラー トークンとして送信します:

curl https://api.speechdash.com/v1/me \
 -H "Authorization: Bearer sh_live_your_key"

有効なキーがないリクエストは 401 で応答し、コードは unauthorized となります。

GET /me はアカウント ID、メールアドレス、プラン、ウォレット残高(wallet_centsdisplay_credits)、および使用された API キーのメタデータを返します。セットアップ後(例: Zapier で)キーの検証に使用できます。

POST /documentsPOST /audio/speech はオプションの Idempotency-Key ヘッダーを受け付けます。同じキーと同じボディでリトライすると、24時間以内に最初の成功した応答が再生成され、ネットワークの一時的な不具合で2つ目のドキュメントが作成されるのを防ぎます。音声応答が保存できない場合、同じキーでリトライすると 409 が返され、再生成は行われず(元のリクエストは既に請求済み)、/audio/speech のクライアント切断は 204 で応答し、生成されたオーディオを決済し、キーを解放してリトライで再生成可能にします。ストリーミングオーディオエンドポイントはこのヘッダーを拒否します。

クレジット

音声合成はアプリと同じウォレットからクレジットを消費します:0.5 クレジット(1 ウォレットセント) が生成されたオーディオの開始した30秒ごとに費用となります。各リクエストは生成開始前に見積もり(小さなマージンを含む)を行い、実際に生成されたオーディオに基づいて決済されます。未使用の保留は返金され、各決済されたリクエストは 設定 → クレジット使用API 音声合成 として表示されます。API レスポンスの billed_credits フィールドはウォレットセント(2セント = 1 ディスプレイクレジット)です。ストリームが途中で中断された場合、既に配信されたセンテンスは請求されます。

ウォレット残高が保留をカバーできない場合、API は 402payment_required コードを返し、生成する前に応答します。

ドキュメントの作成はクレジットを消費しませんが、プランの日次ドキュメント制限(無料: 3件/日; Unlimited: 日次制限なし)およびアップロード時間制限にカウントされます。ファイルのエクスポートはクレジットを消費しません。

請求とインアプリ Cloud 再生

インアプリの Cloud 再生はドキュメントごとのセンテンスキャッシュを再利用します。サーバーで既に生成されたセンテンスを再生する場合、費用は 0 ディスプレイクレジット になる可能性があります。RESTMCP の音声エンドポイントは常に新しい音声を合成し、生成時に開始した30秒ごとに同じ率で請求されます。API または MCP の音声合成には再生キャッシュはありません。

制限

制限
/documents へのリクエスト1分間に120回、アカウントごと
/audio/* へのリクエスト1分間に60回、アカウントごと
並列音声リクエスト3回、アカウントごと
POST /audio/speechinput5,000文字
POST /audio/streaminput20,000文字
ドキュメントテキスト500,000文字
アクティブな API キー10

レート制限はアカウントごとにカウントされ、キーごとではないため、追加のキーはクォータを上げません。各応答には X-Request-ID が含まれ、 /documents/audio/*X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset も返します。サポートに連絡する際は X-Request-ID を引用してください。

音声リクエストには並列性の上限もあります。4つ目の同時リクエストは3つがまだ実行中の場合に 429 で応答し、1つの統合が合成を独占することを防ぎます。429503Retry-After ヘッダー後にリトライできます。

音声合成の制限を超えるコンテンツがある場合は、ドキュメントを POST /v1/documents で作成し、アプリからその音声をエクスポートしてください。

ドキュメント: 共有、翻訳、エクスポート

シリアライズされたドキュメントには visibilityshare_url(プライベートの場合は null)が含まれます。PUT /v1/documents/{id}visibility を受け付け、読み取り専用の非公開ページを /share/document/{id} に公開し、また is_archived をアーカイブまたは復元することができます。共有ページはテキストのみです。有料のオーディオは再生されません。

POST /v1/documents/{id}/translate は新しい翻訳版を作成します。これは MP3 エクスポートと同じクレジットウォレット(開始した30秒ごとに0.5クレジット)を請求し、ウォレットが不足している場合は 402 を返し、翻訳が設定されていないかダウンしている場合は 503 を返します。

GET /v1/documents/{id}/export?format=pdf|docx|txt|csv|srt|vtt は現在のバージョンをアタッチメントとしてダウンロードします。PDF、DOCX、TXT、CSV に timestamps=1 を追加してセクションのタイムスタンプを含めます。SRT と VTT はトランスクリプトまたは完全なセンテンスのタイムスタンプが必要です。GET /v1/documents/{id} で保存された text はトランスクリプトのタイムスタンプヘッダーを保持します。それらを隠すことはアプリのリーダー設定のみです。

関連項目

On this page