APIリファレンス
VoiceCheap APIは標準的なHTTPメソッドとステータスコードを使用します。ほとんどのエンドポイントはJSONを返し、文字起こしのエクスポートではSRTまたはVTTも返せます。 アカウント設定、チーム管理、メディアツール、その他のワークフローには、アクションカタログを使用してください。これらのワークフローはアカウント用 MCP サーバーからも利用できます。ただし、Webhook 署名シークレットの作成とローテーションには REST が必要です。連携で認証情報を管理し、使用制限を確認してください。ベースURL
すべてのAPIリクエストは以下に対して行う必要があります:認証
非公開の REST 呼び出しは、x-api-key または Authorization: Bearer に API キーを指定して認証します。OpenAPI ドキュメントは公開されています。権限範囲を設定した認証情報と MCP 用 OAuth については、認証を参照してください。
JSONアクションAPI
アカウント、チーム、プロジェクト、音声、メディアツールの各セクションで、JSONアクションを個別に説明しています。これらのルートは読み取りや削除も含め、すべてPOST を使用します。引数はJSON本文で送信してください。以下のファイルアップロードと既存のプロジェクトルートは、それぞれのHTTPメソッドを引き続き使用します。
account:read 権限を持つAPIキーを作成し、環境変数 VOICECHEAP_API_KEY を設定して、読み取り専用のリクエストを試してください。
data に含まれます。時間のかかるアクションはHTTP 202と requestId を返します。リクエストの状態から結果を取得してください。アクションのリクエストが完了しても、メディア処理が続く場合があります。
分野別の全アクションを参照するか、キーに許可されたアクションとスキーマを確認してください。各ページに権限、パラメーター、例、エラーを記載しています。
コンテンツタイプ
- リクエスト: ファイルアップロードには
multipart/form-dataを、その他のリクエストにはapplication/jsonを使用してください - レスポンス: JSONエンドポイントは
application/jsonを返します。文字起こしのエクスポートではSRTまたはVTTテキストを返すこともできます。
ファイルアップロードと既存のプロジェクトルート
メディアの文字起こし
POST /v1/transcribeアップロードされたファイルをJSON、SRT、またはVTTとして文字起こしします。プロジェクトの文字起こしをエクスポート
POST /v1/projects/{projectId}/transcriptオリジナルまたは翻訳済みのプロジェクトの文字起こしを取得します。プロジェクトを作成
POST /v1/projects動画または音声ファイルをアップロードし、翻訳せずに文字起こしを開始します。翻訳を開始
POST /v1/translateビデオまたはオーディオファイルをアップロードし、翻訳プロジェクトを開始します。プロジェクトを吹き替え
POST /v1/projects/{projectId}/dub文字起こし済みのプロジェクトを、自分で翻訳したSRTから吹き替えます。翻訳ステータスを取得
GET /v1/translate/{projectId}/status翻訳プロジェクトのステータスを確認し、結果を取得します。プロジェクトの詳細を取得
GET /v1/projects/{projectId}翻訳されたバージョン履歴、リップシンク履歴、およびプロジェクトの状態を取得します。プロジェクトを削除
DELETE /v1/translate/{projectId}翻訳プロジェクトとそのアセットを完全に削除します。翻訳ワークフロー
ビデオを翻訳するための一般的なワークフローは以下の通りです:レスポンス形式
以下の既存のファイルアップロードとプロジェクトルートは、各エンドポイント固有のレスポンス形式を維持します。 成功時のレスポンス項目はエンドポイントによって異なります。プロジェクト作成と吹き替え開始ではsuccess、message、projectIdが返ります。ステータスとプロジェクト詳細ではプロジェクトの状態が返り、文字起こしではJSON、SRT、VTTが返ります。正確な項目は各エンドポイントのページを確認してください。
エラーはcodeとmessageを含むJSONオブジェクトとして返り、detailsが含まれる場合もあります。エラーコードを参照してください。