> ## 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.
# プロジェクトを取得
> プロジェクトの詳細、編集可能な設定、セグメントのリビジョン、出力 URL、翻訳バージョンを取得します。
プロジェクトの詳細、編集可能な設定、セグメントのリビジョン、出力 URL、翻訳バージョンを取得します。
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/projects_get
```
## 認証と権限
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: `projects:read`.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
## パラメーター
テキスト値。
最小文字数: 1. 最大文字数: 200. パターン: `^[^/\\]+$`.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
```json theme={null}
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
```
## リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/projects_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。
公開用のプロジェクト詳細、顧客設定、現在のソース構造リビジョン、すべての翻訳出力バージョンを返します。
```json HTTP 200 theme={null}
{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"status": "success",
"workflow": "translation",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progress": {
"step": "done",
"transcriptionProgress": 100,
"transcriptionStatus": "success"
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
],
"segmentStructureRevision": 3,
"numberOfSpeakers": 1,
"translationInstructions": "",
"isReadyForDubbing": true,
"settings": {
"voiceCloning": true,
"customVoice": false,
"customVoiceId": "",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"activeSpeakerDetectionEnabled": false,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"voiceIsolatorOption": "studio",
"voiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
}
}
}
}
```
## 結果フィールド
| フィールド | 説明 |
| - | - |
| `data.projectId` | アクセス可能なプロジェクトの識別子。 |
| `data.projectName` | 顧客に表示されるプロジェクト名。 |
| `data.status` | プロジェクト概要のステータス：processing、success、failed のいずれか。 |
| `data.workflow` | 文字起こし専用プロジェクトは transcription、吹き替えプロジェクトは translation。 |
| `data.originalVideoUrl` | 音声プロジェクトを含む、保存済みの元メディア URL。存在しない場合は空文字列。 |
| `data.originalLanguage` | 検出または選択されたソース言語。取得できない場合は unknown。 |
| `data.targetLanguages` | 対象言語名の配列。 |
| `data.duration` | 元のメディアの長さ（秒）。 |
| `data.createdAt` | プロジェクトの作成時刻（Unixミリ秒）。 |
| `data.progress` | 公開用の文字起こしステップ、任意の transcriptionProgress、および transcriptionStatus。 |
| `data.translations` | すべての言語別作業データの全翻訳バージョン。正規化された createdAt の新しい順に並びます。 |
| `data.segmentStructureRevision` | 現在の原文セグメント構造のリビジョン。デフォルトは 0。この値を segments\_delete または segments\_merge の expectedSegmentStructureRevision として渡してください。 |
| `data.numberOfSpeakers` | 保存されているソースの話者数。存在する場合のみ。 |
| `data.translationInstructions` | 現在のプロジェクト翻訳指示。保存されていない場合は空文字列。 |
| `data.isReadyForDubbing` | 保存済みプロジェクトが吹き替え準備完了に設定されている場合のみ true。 |
| `data.settings` | プロジェクトの吹き替え設定または旧設定から選ばれた、任意のユーザー設定。保存済みフィールドのみを返し、未設定の任意値は省略します。 |
| `data.settings.voiceCloning` | 任意のプロジェクト音声クローン設定。 |
| `data.settings.customVoice` | 任意のカスタム音声設定。 |
| `data.settings.customVoiceId` | 任意のカスタム音声識別子。 |
| `data.settings.keepBackgroundMusic` | 任意の背景音声設定。 |
| `data.settings.keepOriginalVoice` | 任意の元音声設定。 |
| `data.settings.originalVoiceVolume` | 任意の元音声の音量。 |
| `data.settings.activeSpeakerDetectionEnabled` | 任意のアクティブ話者検出設定。 |
| `data.settings.subtitles` | 任意の \{isEnable,source} 字幕設定。 |
| `data.settings.smartSync` | 任意の SmartSync 設定。 |
| `data.settings.voiceIsolatorOption` | 任意の音声分離設定。studio または realistic。 |
| `data.settings.voiceCloningSettings` | 任意の \{stability,similarity} 音声クローン設定。 |
| `data.error` | プロジェクト全体の処理失敗を示す、任意の公開 \{code,message}。 |
| `data.translations[].workId` | このバージョンを含む言語ワークの識別子。 |
| `data.translations[].translatedVersionId` | 特定の吹き替え出力バージョンの識別子。 |
| `data.translations[].targetLanguage` | バージョンの翻訳先言語。未設定の場合は言語別作業データの言語を使用します。 |
| `data.translations[].status` | 保存済みバージョンの状態：not-started、in-progress、completed、failed。 |
| `data.translations[].currentStep` | 任意の吹き替えパイプラインのステップ。progress は任意の数値の進捗値です。 |
| `data.translations[].progress` | 任意の吹き替え進捗の値。 |
| `data.translations[].createdAt` | Unix ミリ秒に正規化された作成時刻。未設定の場合は言語別作業データの作成時刻を使用します。 |
| `data.translations[].completedAt` | 任意の完了時刻。Unix ミリ秒。 |
| `data.translations[].failedAt` | 任意の失敗時刻。Unix ミリ秒。 |
| `data.translations[].timedOutAt` | 任意のタイムアウト時刻。Unix ミリ秒。 |
| `data.translations[].translatedVideoUrl` | 保存済みの翻訳動画 URL。利用できない場合は空文字列。 |
| `data.translations[].translatedAudioUrl` | 保存済みの翻訳音声 URL。利用できない場合は空文字列。 |
| `data.translations[].error` | バージョンが失敗した場合の、任意の \{code,message}。 |
| `data.translations[].settings` | 公開バージョン設定：voiceCloning、uploadType、keepBackgroundMusic、keepOriginalVoice、originalVoiceVolume、subtitles、smartSync、dubbingMode、voiceIsolatorOption、および任意の translationQualityMode、cutBecauseFreeUser、originalDurationSeconds、cutDurationSeconds、voiceCloningSettings。 |
| `data.translations[].settings.dubbingMode` | translate または dub-only。dub-only バージョンでは SmartSync は false です。 |
| `data.translations[].lipSync` | 任意の \{latest,history}。各項目は jobId、status、videoUrl、errorMessage、type、createdAt、および任意の requestedAt、retryRequestedAt、completedAt、failedAt、timedOutAt、activeSpeakerDetectionEnabled、isRetried を含みます。リップシンクの時刻は ISO 文字列として保存されます。 |
| `data.translations[].dynamicSubtitles` | 任意のオブジェクト。used、inProgress、magicZooms、magicBrolls、magicBrollsPercentage、videoUrl、errorMessage、および任意の removeSilencePace、removeBadTakes、templateName、requestedAt、rerunCount を含みます。requestedAt は Unix ミリ秒です。 |
| `data.translations[].publicationAttempts` | 任意の公開試行の配列。id、status、origin、および任意の scheduledAt、processingStartedAt、publishedAt、failedAt、privacyStatus、url、videoId、errorMessage を含みます。 |
| `data.translations[].publishedVideos` | type、videoId、privacyStatus と、任意の url、datePublished、origin、scheduledAt、plannedPublicationId を含む任意の配列。 |
## 操作の注意事項
* このアクションは文字起こしテキストや生のセグメントドキュメントを返しません。文字起こしの内容には transcripts\_get、言語別ワークのメタデータには translations\_list を使用してください。
* 存在しない任意のネストフィールドは、シリアライズされた JSON から省略されます。出力 URL は、対応する出力が利用可能になるまで空文字列です。
* プロジェクトのステータスは、ワークフローと最新の翻訳バージョンを要約します。複数の言語を管理する場合は、translations\[] の各項目を確認してください。
* error フィールドは保存済みの処理エラーを示します。失敗したプロジェクトを正常に取得できた場合も、通常の結果を返します。
* 保存された失敗は、VoiceCheap のエラーコードと固定メッセージを返します。コードとリソースの現在の状態を使って、復旧方法を判断してください。
## 使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。
## エラー
| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `VALIDATION_ERROR` | スキーマに従って入力を修正してください。無効な値や整合性のない値は実行前に拒否されます。 |
| 401 | `API_KEY_EXPIRED` | API キーの有効期限が切れています。 |
| 401 | `INVALID_API_KEY` | 有効期限内の有効な API キーを指定してください。 |
| 401 | `INVALID_CREDENTIAL` | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | `MISSING_CREDENTIAL` | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | `USER_NOT_FOUND` | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | `FORBIDDEN` | 認証済み実行者は、このプロジェクトにアクセスできません。 |
| 403 | `INSUFFICIENT_SCOPE` | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `PROJECT_NOT_FOUND` | アクセス可能なアカウントにこのプロジェクトは存在しません。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["projects:read"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.