> ## 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/glossary_get
```

## 認証と権限

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

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

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

## パラメーター

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

  最小文字数: 2. 最大文字数: 64.
</ParamField>

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "sourceLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 64
      }
    },
    "required": ["sourceLanguage"],
    "additionalProperties": false
  }
  ```
</Accordion>

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"sourceLanguage":"english"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    sourceLanguage: 'english',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_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/glossary_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"sourceLanguage": "english"},
      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": {
      "glossaryId": "user_123__english",
      "sourceLanguage": "english",
      "canWrite": true,
      "isActive": true,
      "defaultApplicationMode": "smart",
      "entryCount": 1,
      "entries": [
        {
          "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
          "sourceText": "product",
          "targets": {
            "french": {
              "text": "Produit",
              "mode": "translate",
              "applicationMode": "smart"
            }
          },
          "createdAt": 1792065600000,
          "updatedAt": 1792152000000
        }
      ]
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.glossaryId` | ワークスペース所有者と正規化されたソース言語に対応する用語集識別子。 |
| `data.sourceLanguage` | 正規化されたソース言語名。 |
| `data.canWrite` | 呼び出し側がこの用語集を所有し、編集できるかどうか。 |
| `data.isActive` | 現在の用語集の有効化フラグ。用語集がまだ存在しない場合のデフォルトは true です。 |
| `data.defaultApplicationMode` | 用語集のデフォルトモード。smart または strict。 |
| `data.entryCount` | 保存済みエントリー数。保存済みの件数がない場合は、読み込んだエントリー数。 |
| `data.entries` | 用語集エントリー。用語集がまだ存在しない場合は空の配列。 |
| `data.entries[].entryId` | 保存済みエントリの識別子。原語の用語を変更すると変わる場合があります。 |
| `data.entries[].sourceText` | 用語集が返す、前後の空白除去・小文字化済みの元用語。 |
| `data.entries[].targets` | 正規化された翻訳先言語名から翻訳ルールへのマップ。 |
| `data.entries[].targets.<language>.text` | その翻訳先言語で使用するテキスト。 |
| `data.entries[].targets.<language>.mode` | translate または keep。 |
| `data.entries[].targets.<language>.applicationMode` | 対象ルールに保存する場合は smart または strict。 |
| `data.entries[].createdAt` | 保存処理が返すエントリー作成タイムスタンプ（ミリ秒）。 |
| `data.entries[].updatedAt` | エントリの保存タイムスタンプ（ミリ秒）。 |

## 操作の注意事項

* 対応するソース言語の用語集が未登録の場合は、算出された glossaryId と空の項目一覧を返します。
* 用語集を編集できるのは所有者だけです。チームメンバーには読み取り権限があります。

## 使用量

正常に実行された呼び出しごとに、月間 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 | `FORBIDDEN` | ワークスペースのプランでは用語集を利用できません。 |
| 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": ["glossary:read"]
  }
}
```


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