> ## 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.

# プロジェクトの使用量ライフサイクルを取得

> ワークスペース内のプロジェクトについて、翻訳とリップシンクの分数課金、返還、ライフサイクルイベントを取得します。

ワークスペース内のプロジェクトについて、翻訳とリップシンクの分数課金、返還、ライフサイクルイベントを取得します。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/usage_project_get
```

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

必要な権限: `usage: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/usage_project_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_123"}'
  ```

  ```javascript JavaScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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)
  ```
</RequestExample>

## レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。

アクティブなワークスペース内で、このプロジェクトの各翻訳実行を通じた分数の合計とライフサイクルイベントを返します。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "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"
        }
      ]
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.kind` | translation または project。 |
| `data.isHistoricalDerived` | 1つ以上の使用量詳細が過去のデータから算出されたかどうか。 |
| `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` | 履歴データから再構成されたイベントであることを示す任意のフラグ。 |

## 操作の注意事項

* アクティブなワークスペース内で、プロジェクトに少なくとも1行の利用状況レコードが必要です。利用状況の行がないプロジェクトはエラーを返します。
* 概要はプロジェクト全体を対象とし、単一の targetLanguage、translationStatus、lipSyncStatus は含みません。各イベントには、該当する場合に翻訳先言語や実行のラベルが含まれます。
* イベントには、未加工の処理エラーメッセージやイベント表示ラベルは含まれません。

## 使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

## エラー

| 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` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["usage:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.