APIリファレンス

VoiceCheap APIはREST原則に基づいて構成されています。標準的なHTTPメソッドを使用し、JSON形式のレスポンスを返し、標準的なHTTPレスポンスコードを使用します。

ベースURL

すべてのAPIリクエストは以下に対して行う必要があります:

https://api.voicecheap.ai

認証

すべてのリクエストには、x-api-keyヘッダーで渡されるAPIキーが必要です。詳細は認証ページを参照してください。

コンテンツタイプ

リクエスト: ファイルアップロードにはmultipart/form-dataを、その他のリクエストにはapplication/jsonを使用してください
レスポンス: JSONエンドポイントはapplication/jsonを返します。文字起こしのエクスポートではSRTまたはVTTテキストを返すこともできます。

利用可能なエンドポイント

メディアの文字起こし

POST /v1/transcribeアップロードされたファイルをJSON、SRT、またはVTTとして文字起こしします。

プロジェクトの文字起こしをエクスポート

POST /v1/projects/{projectId}/transcriptオリジナルまたは翻訳済みのプロジェクトの文字起こしを取得します。

翻訳を開始

POST /v1/translateビデオまたはオーディオファイルをアップロードし、翻訳プロジェクトを開始します。

翻訳ステータスを取得

GET /v1/translate/{projectId}/status翻訳プロジェクトのステータスを確認し、結果を取得します。

プロジェクトの詳細を取得

GET /v1/projects/{projectId}翻訳されたバージョン履歴、リップシンク履歴、およびプロジェクトの状態を取得します。

プロジェクトを削除

DELETE /v1/translate/{projectId}翻訳プロジェクトとそのアセットを完全に削除します。

翻訳ワークフロー

ビデオを翻訳するための一般的なワークフローは以下の通りです:

レスポンス形式

すべての成功したレスポンスは、この一般的な構造に従います:

{
  "success": true,
  "message": "Description of the result"
  // Additional fields specific to the endpoint
}

エラーレスポンスはこの構造に従います:

{
  "code": "ERROR_CODE",
  "message": "Human-readable error description"
}

HTTPステータスコード

ステータスコード	説明
200	成功
400	不正なリクエスト - 無効なパラメータ
401	認証失敗 - APIキーが無効または未指定
403	アクセス拒否 - 権限またはクレジット不足
404	見つかりません - リソースが存在しません
429	リクエスト過多 - レート制限を超過しました
500	内部サーバーエラー

​APIリファレンス

​ベースURL

​認証

​コンテンツタイプ

​利用可能なエンドポイント