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

# フォルダーを取得

> アクティブなワークスペースのフォルダー名、翻訳指示、プロジェクト ID、および任意のプロジェクト指標を取得します。

アクティブなワークスペースのフォルダー名、翻訳指示、プロジェクト ID、および任意のプロジェクト指標を取得します。

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

## 認証と権限

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

必要な権限: `folders:read`.

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

## パラメーター

<ParamField body="folderId" type="string" required>
  テキスト値。

  最小文字数: 1. 最大文字数: 200. パターン: `^[^/]+$`.
</ParamField>

<ParamField body="includeProjectMetrics" type="boolean">
  真偽値。

  デフォルト値: false.
</ParamField>

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

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

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
    includeProjectMetrics: true,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_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/folders_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
      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": {
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
      "folderName": "Product videos",
      "projectIds": [
        "project_123"
      ],
      "dateCreated": 1792065600000,
      "translationInstructions": "Keep product names unchanged.",
      "projectMetrics": {
        "projectsCount": 1,
        "totalDurationSeconds": 120,
        "translatedProjectsCount": 1,
        "translationsInProgressProjectsCount": 0,
        "awaitingProofreadingProjectsCount": 0
      }
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.folderId` | フォルダー識別子。以降のフォルダーアクションでは、返された値を使用してください。 |
| `data.folderName` | 現在のフォルダー名。 |
| `data.projectIds` | このフォルダーに割り当てられた、アクセス可能なプロジェクトの識別子。 |
| `data.dateCreated` | フォルダーの作成時刻を表す Unix タイムスタンプ（ミリ秒）。 |
| `data.translationInstructions` | フォルダーに保存された翻訳指示。空文字列は指示なしを意味します。 |
| `data.projectMetrics` | 指標を要求した場合に含まれます。 |
| `data.projectMetrics.projectsCount` | projectIds に含まれるアクセス可能なプロジェクトの数。 |
| `data.projectMetrics.totalDurationSeconds` | ソースの合計時間。秒単位。 |
| `data.projectMetrics.translatedProjectsCount` | すべての翻訳先言語で翻訳済みとマークされたプロジェクト。 |
| `data.projectMetrics.translationsInProgressProjectsCount` | 翻訳が進行中のプロジェクト。 |
| `data.projectMetrics.awaitingProofreadingProjectsCount` | 校正待ちのプロジェクト。 |

## 操作の注意事項

* includeProjectMetrics のデフォルトは false です。指定しない限り、指標は省略されます。
* チームのゲストの場合、projectIds と要求された集計値には、アクティブなチームで本人が API を通じて作成したプロジェクトのみが含まれます。保存結果と再実行にも同じプロジェクトアクセス確認が適用されます。

## 使用量

正常に実行された呼び出しごとに、月間 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 | `UNAUTHORIZED` | フォルダーはアクティブなワークスペースに属していません。 |
| 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": ["folders:read"]
  }
}
```


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