言語別作業データを取得

curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24"}'

const input = {
  projectId: 'project_launch_2026',
  workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_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);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/translations_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
    "projectId": "project_launch_2026",
    "targetLanguage": "english",
    "originalLanguage": "fr",
    "createdAt": 1792152000000,
    "isWorkWaitingForProofreading": false,
    "pendingSegmentIndexes": [],
    "versions": [
      {
        "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"
        }
      }
    ]
  }
}

POST

actions

translations_get

curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24"}'

const input = {
  projectId: 'project_launch_2026',
  workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_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);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/translations_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
    "projectId": "project_launch_2026",
    "targetLanguage": "english",
    "originalLanguage": "fr",
    "createdAt": 1792152000000,
    "isWorkWaitingForProofreading": false,
    "pendingSegmentIndexes": [],
    "versions": [
      {
        "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"
        }
      }
    ]
  }
}

言語別作業データのメタデータ、処理待ちセグメントのインデックス、正規化された出力バージョンを取得します。

POST https://api.voicecheap.ai/v1/actions/translations_get

認証と権限

string

必須

このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。

必要な権限: projects:read. 有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

パラメーター

string

必須

テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.

string

必須

テキスト値。最小文字数: 1. 最大文字数: 200. パターン: ^[^/\\]+$.

完全な入力スキーマ

以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

{
  "type": "object",
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[^/\\\\]+$"
    },
    "workId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[^/\\\\]+$"
    }
  },
  "required": ["projectId", "workId"],
  "additionalProperties": false
}

リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24"}'

const input = {
  projectId: 'project_launch_2026',
  workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_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);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/translations_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。アクセスが許可された言語別ワーク 1 件の表示用データと、その公開バージョンを返します。

{
  "data": {
    "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
    "projectId": "project_launch_2026",
    "targetLanguage": "english",
    "originalLanguage": "fr",
    "createdAt": 1792152000000,
    "isWorkWaitingForProofreading": false,
    "pendingSegmentIndexes": [],
    "versions": [
      {
        "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"
        }
      }
    ]
  }
}

結果フィールド

フィールド	説明
`data.workId`	言語ワークの識別子。
`data.projectId`	親プロジェクトの識別子。
`data.targetLanguage`	対象言語。
`data.originalLanguage`	ソース言語。
`data.createdAt`	Unix ミリ秒に正規化した言語別ワークの作成時刻。
`data.isWorkWaitingForProofreading`	校正状態。明示的に設定されていない場合は false。
`data.pendingSegmentIndexes`	まだ翻訳待ちの原文セグメントのインデックス。デフォルトは空の配列。
`data.versions`	この作業に含まれるすべての公開バージョン。新しい順。
`data.versions[].workId`	このバージョンを含む言語ワークの識別子。
`data.versions[].translatedVersionId`	特定の吹き替え出力バージョンの識別子。
`data.versions[].targetLanguage`	バージョンの翻訳先言語。未設定の場合は言語別作業データの言語を使用します。
`data.versions[].status`	保存済みバージョンの状態：not-started、in-progress、completed、failed。
`data.versions[].currentStep`	任意の吹き替えパイプラインのステップ。progress は任意の数値の進捗値です。
`data.versions[].progress`	任意の吹き替え進捗の値。
`data.versions[].createdAt`	Unix ミリ秒に正規化された作成時刻。未設定の場合は言語別作業データの作成時刻を使用します。
`data.versions[].completedAt`	任意の完了時刻。Unix ミリ秒。
`data.versions[].failedAt`	任意の失敗時刻。Unix ミリ秒。
`data.versions[].timedOutAt`	任意のタイムアウト時刻。Unix ミリ秒。
`data.versions[].translatedVideoUrl`	保存済みの翻訳動画 URL。利用できない場合は空文字列。
`data.versions[].translatedAudioUrl`	保存済みの翻訳音声 URL。利用できない場合は空文字列。
`data.versions[].error`	バージョンが失敗した場合の、任意の {code,message}。
`data.versions[].settings`	公開バージョン設定：voiceCloning、uploadType、keepBackgroundMusic、keepOriginalVoice、originalVoiceVolume、subtitles、smartSync、dubbingMode、voiceIsolatorOption、および任意の translationQualityMode、cutBecauseFreeUser、originalDurationSeconds、cutDurationSeconds、voiceCloningSettings。
`data.versions[].settings.dubbingMode`	translate または dub-only。dub-only バージョンでは SmartSync は false です。
`data.versions[].lipSync`	任意の {latest,history}。各項目は jobId、status、videoUrl、errorMessage、type、createdAt、および任意の requestedAt、retryRequestedAt、completedAt、failedAt、timedOutAt、activeSpeakerDetectionEnabled、isRetried を含みます。リップシンクの時刻は ISO 文字列として保存されます。
`data.versions[].dynamicSubtitles`	任意のオブジェクト。used、inProgress、magicZooms、magicBrolls、magicBrollsPercentage、videoUrl、errorMessage、および任意の removeSilencePace、removeBadTakes、templateName、requestedAt、rerunCount を含みます。requestedAt は Unix ミリ秒です。
`data.versions[].publicationAttempts`	任意の公開試行の配列。id、status、origin、および任意の scheduledAt、processingStartedAt、publishedAt、failedAt、privacyStatus、url、videoId、errorMessage を含みます。
`data.versions[].publishedVideos`	type、videoId、privacyStatus と、任意の url、datePublished、origin、scheduledAt、plannedPublicationId を含む任意の配列。

操作の注意事項

workId は projectId に属し、保存済みのプロジェクト所有者が同一である必要があります。
pendingSegmentIndexes は翻訳がまだ必要なテキストを示します。セグメントアクションキューとは別です。
保存された失敗は、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`	アクセス可能なアカウントにこのプロジェクトは存在しません。
404	`TRANSLATION_NOT_FOUND`	workId は、このプロジェクトに属する言語別ワークを指していません。
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	月次リセットを待つか、プランを変更してください。
429	`INTEGRATION_RATE_LIMIT_REACHED`	Retry-After がある場合は指定時間を待ち、バックオフを使用してください。
500	`INTERNAL_ERROR`	変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。
503	`SERVER_RESTARTING`	サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["projects:read"]
  }
}

概要

ディスカバリー

アカウント

使用量とアクティビティ

設定と通知

チーム

プロジェクト

翻訳と吹き替え

文字起こしと編集

テキスト読み上げ

読み上げ音声

吹き替え音声

文字起こし

字幕とキャプション

画像

サムネイル

フォルダー

用語集

Webhook

公開

リクエストの状態

OAuth と MCP プロトコル

認証と権限

パラメーター

リクエスト例

レスポンス

結果フィールド

操作の注意事項

使用量

エラー

​認証と権限

​パラメーター

​リクエスト例

​レスポンス

​結果フィールド

​操作の注意事項

​使用量

​エラー

認証と権限

パラメーター

リクエスト例

レスポンス

結果フィールド

操作の注意事項

使用量

エラー