文字起こし API:概要、認証、制限
VoxScriber の REST API の使い方:アクセス権限、vpt_live_ キーの仕組み、Bearer 認証、リクエスト制限、サイクル課金。
VoxScriber の REST API を使うと、サイトを経由せずに、URL で音声を送信して、そのまま文字起こし結果を自分のシステムで受け取れます。パネルでの文字起こしと同じエンジンを使用し、同じサイクルを消費します。
利用できるユーザー
API は Profissional プラン(月額 R$ 39,90) から利用できます。対象となるのは、Profissional、Premium、すべての Empresariais プラン(月払い・年払い)、および同等のレガシープランです。アカウントが対象でない場合、キー関連のルートは 403 PLAN_NOT_ELIGIBLE エラーを返します。
APIキー
キーを作成
秘密キーをすぐにコピー
vpt_live_... という形式で、作成時に一度だけ表示されます。当社はキーのハッシュのみを保持するため、後から再表示することはできません。安全に保管
キーを紛失しましたか?再表示する方法はありません。古いキーを失効させて、新しいキーを作成してください。漏えいしたキーは直ちに失効させる必要があります。
個人キーの作成には、現在パネルに専用画面がありません。ご利用のプランが対象で、API を始めたい場合は、チケットを開いて ください。担当者がアクセスを有効化します。
認証
すべてのリクエストには、Authorization ヘッダーでキーを指定します。
Authorization: Bearer vpt_live_SUA_CHAVE
ヘッダーがないリクエストは 401 MISSING_API_KEY を返します。
音声を文字起こしに送信する
文字起こしエンドポイントはゲートウェイ api.voxscriber.com にあります。
curl -X POST https://api.voxscriber.com/v1/transcriptions \
-H "Authorization: Bearer vpt_live_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"audio_url": "https://exemplo.com/gravacoes/reuniao.mp3",
"webhook_url": "https://seusistema.com/webhooks/vozparatexto",
"formats": ["txt", "srt"]
}'
リクエストボディで受け付けられるフィールド: audio_url、webhook_url、engine(ASSEMBLYAI、WHISPER、ELEVENLABS)、language、formats(txt、json、srt、vtt、docx、pdf)、metadata、idempotency_key。結果は指定した webhook_url に届きます。Webhooks と通知 を参照してください。
idempotency_key には、ご自身の識別子(例:システム内の録音 ID)を使用してください。同じリクエストが誤って再送信されても、音声が二重に処理(および課金)されることはありません。
制限
| 制限 | 値 |
|---|---|
| キーあたりのリクエスト数 | 毎分60件 |
| URLからダウンロードする音声 | 最大500 MB(タイムアウト60秒) |
| パススルー経由の音声(PremiumエンジンがURLを直接読み取る) | 最大5 GB |
| アカウントあたりのアクティブなキー数 | 20 |
URLのセキュリティルール: https のみ、リダイレクトなし、内部/プライベートアドレスはブロックされます。音声の URL は公開アクセス可能である必要があります。
利用可能なエクスポート形式は、サイトと同様にプランのゲートに従います。プラン外の形式は exports_skipped にリストされて返されます。
課金
API は、サイトでの文字起こしと同じサイクルを、選択したエンジンに応じて消費します(Padrão/Whisper: 1サイクル/分、Premium: 4サイクル/分、Ultra: 10サイクル/分)。現時点では、月間の呼び出しクォータやキーごとの利用上限はありません。サイクル残高で消費量を管理してください。サイクルとは?1分あたりのコスト を参照してください。
FAQ
APIキーを紛失しました。どうやって再取得できますか?
再取得はできません。データベースにはハッシュしか保存されていません。紛失したキーを失効させ、新しいキーを作成してください。
APIはサイトよりも料金が高くなりますか?
いいえ。サイクルコストは同一で、エンジンと音声の長さによって決まります。
URLではなくファイルを直接送れますか?
主な経路は audio_url です。音声に公開 URL がない場合は、サポートにご相談いただければ、最適なフローを検討します。
OpenAPI ドキュメントはありますか?
公開仕様は /.well-known/openapi.json にあり、現在は公開エンドポイント(統計情報と共有文字起こし)のみをカバーしています。それ以外については、このヘルプセンターとサポートをご利用ください。
関連記事
解決しませんか?チケットを開いて ください。担当者が迅速に対応します。