> ## 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_status
```

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `projects:read`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

<ParamField body="projectId" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 200. 匹配模式: `^[^/\\]+$`.
</ParamField>

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_status' \
    --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_status', {
    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_status",
      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)
  ```
</RequestExample>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

返回处理进度和已完成输出的 URL，不嵌入转写文本。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "projectName": "Product launch",
      "originalVideoUrl": "https://media.example.com/launch/original.mp4",
      "originalLanguage": "fr",
      "targetLanguage": "english",
      "duration": 75,
      "createdAt": 1792152000000,
      "workflow": "translation",
      "transcriptionStatus": "success",
      "actualProgressStep": "done",
      "translationAndTranscriptionProgress": 100,
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
      "dubbingStep": "done",
      "dubbingProgress": 100,
      "status": "success",
      "translatedVideoUrl": "https://media.example.com/launch/english.mp4",
      "translatedAudioUrl": "https://media.example.com/launch/english.mp3"
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.projectId` | 父项目标识符。 |
| `data.projectName` | 项目名称。 |
| `data.originalVideoUrl` | 原始存储的媒体 URL 或空字符串。 |
| `data.originalLanguage` | 源语言，或 unknown。 |
| `data.targetLanguage` | 项目配置的第一个目标语言，默认为 english；这并非所有语言内容的列表。 |
| `data.duration` | 媒体时长，单位为秒。 |
| `data.createdAt` | 项目创建时间，以 Unix 毫秒表示。 |
| `data.workflow` | transcription 或 translation。 |
| `data.transcriptionStatus` | processing、success 或 failed。 |
| `data.actualProgressStep` | 当前项目步骤；转写完成且配音仍在进行时，会替换为配音步骤。 |
| `data.translationAndTranscriptionProgress` | 可选的已存储转写进度。 |
| `data.status` | 当前工作流程的 processing、success 或 failed 状态。 |
| `data.workId` | 最新语言内容中存在最新翻译版本时包含此字段。 |
| `data.translatedVersionId` | 最新语言内容中的最新版本标识符。 |
| `data.dubbingStep` | 该版本可选的配音步骤。 |
| `data.dubbingProgress` | 该版本可选的配音进度。 |
| `data.translatedVideoUrl` | 成功完成的版本存在视频 URL 时包含此字段。 |
| `data.translatedAudioUrl` | 成功完成的版本包含此字段；未存储音频 URL 时为空字符串。 |
| `data.lipSync` | 可选的最新口型同步条目，包含 jobId、status、videoUrl、errorMessage、公开的 type、createdAt，以及可选的 requestedAt、completedAt、failedAt、timedOutAt、activeSpeakerDetectionEnabled。 |
| `data.error` | 项目处理、翻译或口型同步失败时可选的公开 \{code,message}。 |

## 操作说明

* 使用此操作轮询 projects\_create、translations\_create、translations\_start、translations\_dub 和 lipsync\_create。请通过 transcripts\_get 单独获取转写文本。
* 此状态读取需要认证且受速率限制，但不消耗每月操作调用限额。
* 对于翻译，此操作跟踪最近创建的语言内容及其最后一个版本。要获取完整的多语言状态，请读取 projects\_get 或 translations\_list。
* 仅转写项目在转写完成时即为成功。若口型同步仍在进行，已完成的配音输出可能仍为 processing；若最近一次口型同步失败，则可能为 failed。
* 处理程序始终从底层状态结果中移除 transcripts。该结果不包含动态字幕完成字段；请轮询 projects\_get 获取这些字段。
* 已保存的失败返回 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` | 可访问的账户中不存在此项目。 |
| 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.