获取语言内容

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 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth 访问令牌。

所需权限: 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)

响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。返回一个已获授权的语言内容投影视图及其公开版本。

{
  "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 调用额度。媒体额度和操作本身的生成限额也适用。

错误

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 协议

身份验证和权限

参数

请求示例

响应

结果字段

操作说明

用量

错误

​身份验证和权限

​参数

​请求示例

​响应

​结果字段

​操作说明

​用量

​错误

身份验证和权限

参数

请求示例

响应

结果字段

操作说明

用量

错误