获取项目用量生命周期

curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_123"}'

const input = {
  projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_123"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "kind": "project",
    "isHistoricalDerived": false,
    "summary": {
      "title": "Product launch",
      "sourceLanguage": "English",
      "totals": {
        "translationBaseMinutes": 2,
        "lipSyncExtraMinutes": 0,
        "lipSyncProExtraMinutes": 0,
        "lipSyncPro2ExtraMinutes": 0,
        "totalChargedMinutes": 2,
        "refundedMinutes": 0,
        "netUsedMinutes": 2
      }
    },
    "events": [
      {
        "id": "project_123-project-created",
        "type": "project_created",
        "timestamp": 1792065540000,
        "tone": "neutral"
      },
      {
        "id": "version_123-translation-launched",
        "type": "translation_launched",
        "timestamp": 1792065600000,
        "tone": "neutral",
        "minuteDelta": 2,
        "relatedRunLabel": "French"
      },
      {
        "id": "version_123-translation-completed",
        "type": "translation_completed",
        "timestamp": 1792065720000,
        "tone": "success",
        "isDerived": false,
        "relatedRunLabel": "French"
      }
    ]
  }
}

POST

actions

usage_project_get

curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_123"}'

const input = {
  projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_123"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "kind": "project",
    "isHistoricalDerived": false,
    "summary": {
      "title": "Product launch",
      "sourceLanguage": "English",
      "totals": {
        "translationBaseMinutes": 2,
        "lipSyncExtraMinutes": 0,
        "lipSyncProExtraMinutes": 0,
        "lipSyncPro2ExtraMinutes": 0,
        "totalChargedMinutes": 2,
        "refundedMinutes": 0,
        "netUsedMinutes": 2
      }
    },
    "events": [
      {
        "id": "project_123-project-created",
        "type": "project_created",
        "timestamp": 1792065540000,
        "tone": "neutral"
      },
      {
        "id": "version_123-translation-launched",
        "type": "translation_launched",
        "timestamp": 1792065600000,
        "tone": "neutral",
        "minuteDelta": 2,
        "relatedRunLabel": "French"
      },
      {
        "id": "version_123-translation-completed",
        "type": "translation_completed",
        "timestamp": 1792065720000,
        "tone": "success",
        "isDerived": false,
        "relatedRunLabel": "French"
      }
    ]
  }
}

获取工作区内项目的翻译和口型同步分钟扣除、退还及生命周期事件。

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

身份验证和权限

string

必填

在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth 访问令牌。

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

参数

string

必填

文本值。最小长度: 1. 最大长度: 200. 匹配模式: ^[^/]+$.

完整输入架构

以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

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

请求示例

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

curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_123"}'

const input = {
  projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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/usage_project_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_123"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。返回当前工作区内此项目各次翻译运行的项目级分钟总数和生命周期事件。

{
  "data": {
    "kind": "project",
    "isHistoricalDerived": false,
    "summary": {
      "title": "Product launch",
      "sourceLanguage": "English",
      "totals": {
        "translationBaseMinutes": 2,
        "lipSyncExtraMinutes": 0,
        "lipSyncProExtraMinutes": 0,
        "lipSyncPro2ExtraMinutes": 0,
        "totalChargedMinutes": 2,
        "refundedMinutes": 0,
        "netUsedMinutes": 2
      }
    },
    "events": [
      {
        "id": "project_123-project-created",
        "type": "project_created",
        "timestamp": 1792065540000,
        "tone": "neutral"
      },
      {
        "id": "version_123-translation-launched",
        "type": "translation_launched",
        "timestamp": 1792065600000,
        "tone": "neutral",
        "minuteDelta": 2,
        "relatedRunLabel": "French"
      },
      {
        "id": "version_123-translation-completed",
        "type": "translation_completed",
        "timestamp": 1792065720000,
        "tone": "success",
        "isDerived": false,
        "relatedRunLabel": "French"
      }
    ]
  }
}

结果字段

字段	说明
`data.kind`	translation 或 project。
`data.isHistoricalDerived`	是否有一项或多项用量详情根据历史数据推算得出。
`data.summary.title`	项目显示名称。
`data.summary.sourceLanguage`	可用时，经过格式化的源语言标签。
`data.summary.targetLanguage`	翻译生命周期的目标语言；项目生命周期中省略此字段。
`data.summary.translationStatus`	翻译生命周期的翻译状态；项目生命周期中省略此字段。
`data.summary.lipSyncStatus`	翻译生命周期的口型同步状态；项目生命周期中会省略。
`data.summary.totals.translationBaseMinutes`	匹配行收取的基础翻译分钟数总计。
`data.summary.totals.lipSyncExtraMinutes`	额外计费的 Standard 口型同步分钟数。
`data.summary.totals.lipSyncProExtraMinutes`	额外计费的 Pro 口型同步分钟数。
`data.summary.totals.lipSyncPro2ExtraMinutes`	额外扣除的 Pro 2 口型同步分钟数。
`data.summary.totals.totalChargedMinutes`	退还前扣除的总分钟数。
`data.summary.totals.refundedMinutes`	已退还的分钟数。
`data.summary.totals.netUsedMinutes`	扣除的分钟数减去退还的分钟数。
`data.events`	按时间戳排序的生命周期事件；无时间戳的事件列于有时间戳的事件之后。
`data.events[].id`	所报告生命周期步骤的稳定事件标识符。
`data.events[].type`	事件类型，例如 project_created、translation_launched、translation_completed 或 lip_sync_refunded。
`data.events[].timestamp`	可选的事件时间戳，单位为毫秒。
`data.events[].tone`	neutral、success、warning 或 danger。
`data.events[].relatedRunLabel`	项目生命周期事件中可选的目标语言和执行标签。
`data.events[].minuteDelta`	可选的分钟数；正数表示扣除，负数表示退还。
`data.events[].isDerived`	可选标记，表示事件根据历史数据重建。

操作说明

项目在当前工作区中必须至少有一条用量行；没有用量行的项目会返回错误。
此摘要涵盖整个项目，省略单一的 targetLanguage、translationStatus 和 lipSyncStatus。各事件在适用时包含目标语言/运行标签。
事件会省略原始处理错误消息和事件显示标签。

用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

错误

HTTP 状态	代码	含义或恢复方式
400	`BAD_REQUEST`	找不到项目，或该项目在当前工作区中没有翻译用量行。
400	`CREDENTIAL_IN_QUERY`	凭证通过 access_token 或 api_key 查询参数提供。请在标头中发送凭证。
400	`VALIDATION_ERROR`	JSON 对象包含不受支持的字段、无效值，或缺少必需参数。
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	`INSUFFICIENT_SCOPE`	请授予全部所需权限，或选择其他凭据。
403	`INTEGRATION_PLAN_UNSUPPORTED`	无法验证该账户的集成限制。
403	`SUBSCRIPTION_REQUIRED`	请使用有效的付费订阅。
403	`TEAM_MEMBERSHIP_INVALID`	账户当前的团队成员关系与此连接的工作区不匹配。请刷新成员关系并重新连接。
403	`TEAM_OWNER_NOT_FOUND`	找不到实际生效的团队所有者账户。
404	`ACCOUNT_NOT_FOUND`	找不到账户或当前工作区账户。
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": ["usage:read"]
  }
}

概述

发现接口

账户

用量和活动

设置和通知

团队

项目

翻译和配音

转写文本和编辑

文本转语音

语音音色

配音音色

转写

字幕

图像

缩略图

文件夹

术语表

Webhook

发布

请求状态

OAuth 和 MCP 协议

身份验证和权限

参数

请求示例

响应

结果字段

操作说明

用量

错误

​身份验证和权限

​参数

​请求示例

​响应

​结果字段

​操作说明

​用量

​错误

身份验证和权限

参数

请求示例

响应

结果字段

操作说明

用量

错误