> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# APIリファレンス

> VoiceCheap REST APIの完全なリファレンス

# APIリファレンス

VoiceCheap APIは標準的なHTTPメソッドとステータスコードを使用します。ほとんどのエンドポイントはJSONを返し、文字起こしのエクスポートではSRTまたはVTTも返せます。

アカウント設定、チーム管理、メディアツール、その他のワークフローには、[アクションカタログ](https://api-docs.voicecheap.ai/docs/ja/api-reference/actions.md)を使用してください。これらのワークフローは[アカウント用 MCP サーバー](https://api-docs.voicecheap.ai/docs/ja/ai/model-context-protocol.md)からも利用できます。ただし、Webhook 署名シークレットの作成とローテーションには REST が必要です。[連携](https://api-docs.voicecheap.ai/docs/ja/ai/integrations.md)で認証情報を管理し、[使用制限](https://api-docs.voicecheap.ai/docs/ja/api-reference/limits.md)を確認してください。

## ベースURL

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

```text theme={null}
https://api.voicecheap.ai
```

## 認証

非公開の REST 呼び出しは、`x-api-key` または `Authorization: Bearer` に API キーを指定して認証します。OpenAPI ドキュメントは公開されています。権限範囲を設定した認証情報と MCP 用 OAuth については、[認証](https://api-docs.voicecheap.ai/docs/ja/authentication.md)を参照してください。

## JSONアクションAPI

アカウント、チーム、プロジェクト、音声、メディアツールの各セクションで、JSONアクションを個別に説明しています。これらのルートは読み取りや削除も含め、すべて `POST` を使用します。引数はJSON本文で送信してください。以下のファイルアップロードと既存のプロジェクトルートは、それぞれのHTTPメソッドを引き続き使用します。

`account:read` 権限を持つAPIキーを作成し、環境変数 `VOICECHEAP_API_KEY` を設定して、読み取り専用のリクエストを試してください。

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/account_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'
```

完了したアクションはHTTP 200を返し、結果は `data` に含まれます。時間のかかるアクションはHTTP 202と `requestId` を返します。[リクエストの状態](https://api-docs.voicecheap.ai/docs/ja/api-reference/actions/requests/action-request-get.md)から結果を取得してください。アクションのリクエストが完了しても、メディア処理が続く場合があります。

[分野別の全アクション](https://api-docs.voicecheap.ai/docs/ja/api-reference/actions.md)を参照するか、[キーに許可されたアクションとスキーマを確認](https://api-docs.voicecheap.ai/docs/ja/api-reference/discovery/actions-list.md)してください。各ページに権限、パラメーター、例、エラーを記載しています。

## コンテンツタイプ

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

## ファイルアップロードと既存のプロジェクトルート

> [card] [メディアの文字起こし](https://api-docs.voicecheap.ai/docs/ja/api-reference/transcribe.md)
>
> `POST /v1/transcribe`
>
> アップロードされたファイルをJSON、SRT、またはVTTとして文字起こしします。

> [card] [プロジェクトの文字起こしをエクスポート](https://api-docs.voicecheap.ai/docs/ja/api-reference/project-transcript.md)
>
> `POST /v1/projects/{projectId}/transcript`
>
> オリジナルまたは翻訳済みのプロジェクトの文字起こしを取得します。

> [card] [プロジェクトを作成](https://api-docs.voicecheap.ai/docs/ja/api-reference/create-project.md)
>
> `POST /v1/projects`
>
> 動画または音声ファイルをアップロードし、翻訳せずに文字起こしを開始します。

> [card] [翻訳を開始](https://api-docs.voicecheap.ai/docs/ja/api-reference/translate.md)
>
> `POST /v1/translate`
>
> ビデオまたはオーディオファイルをアップロードし、翻訳プロジェクトを開始します。

> [card] [プロジェクトを吹き替え](https://api-docs.voicecheap.ai/docs/ja/api-reference/dub-project.md)
>
> `POST /v1/projects/{projectId}/dub`
>
> 文字起こし済みのプロジェクトを、自分で翻訳したSRTから吹き替えます。

> [card] [翻訳ステータスを取得](https://api-docs.voicecheap.ai/docs/ja/api-reference/translation-status.md)
>
> `GET /v1/translate/{projectId}/status`
>
> 翻訳プロジェクトのステータスを確認し、結果を取得します。

> [card] [プロジェクトの詳細を取得](https://api-docs.voicecheap.ai/docs/ja/api-reference/project-details.md)
>
> `GET /v1/projects/{projectId}`
>
> 翻訳されたバージョン履歴、リップシンク履歴、およびプロジェクトの状態を取得します。

> [card] [プロジェクトを削除](https://api-docs.voicecheap.ai/docs/ja/api-reference/delete-project.md)
>
> `DELETE /v1/translate/{projectId}`
>
> 翻訳プロジェクトとそのアセットを完全に削除します。

## 翻訳ワークフロー

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

```mermaid theme={null}
sequenceDiagram
    participant Client as クライアント
    participant API
    participant Processing as 処理

    Client->>API: POST /v1/translate (ファイルとオプション)
    API->>Processing: 翻訳処理をキューに追加
    API-->>Client: 201 (projectId)

    loop ステータスを確認
        Client->>API: GET /v1/translate/{projectId}/status
        API-->>Client: status (processing/success/failed)
    end

    Note over Client: ステータスが"success"になったら翻訳済み動画のURLを取得
```

## レスポンス形式

以下の既存のファイルアップロードとプロジェクトルートは、各エンドポイント固有のレスポンス形式を維持します。

成功時のレスポンス項目はエンドポイントによって異なります。プロジェクト作成と吹き替え開始では`success`、`message`、`projectId`が返ります。ステータスとプロジェクト詳細ではプロジェクトの状態が返り、文字起こしではJSON、SRT、VTTが返ります。正確な項目は各エンドポイントのページを確認してください。

エラーは`code`と`message`を含むJSONオブジェクトとして返り、`details`が含まれる場合もあります。[エラーコード](https://api-docs.voicecheap.ai/docs/ja/api-reference/errors.md)を参照してください。

## HTTPステータスコード

| ステータスコード | 説明 |
| - | - |
| 200 | 成功 |
| 201 | 作成済み - プロジェクトまたは吹き替え処理を開始 |
| 202 | 受付済み - リクエストIDで非同期アクションを追跡 |
| 400 | 不正なリクエスト - 無効なパラメータ |
| 401 | 認証失敗 - APIキーが無効または未指定 |
| 403 | アクセス拒否 - 権限またはクレジット不足 |
| 404 | 見つかりません - リソースが存在しません |
| 409 | 競合 - プロジェクトの状態がリクエストを許可しない |
| 413 | ファイルが大きすぎます - アップロードが上限を超過 |
| 429 | リクエスト過多 - レート制限を超過しました |
| 500 | 内部サーバーエラー |
| 502 | 処理エラー - 文字起こしを完了できない |
| 503 | 一時的に利用不可 - 同じリクエストIDを保持し、再試行前に状態を確認 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.