> ## 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.
# 用語集の項目をインポート
> 既存の項目を消去せずに用語集の行をインポートします。Merge は一致する用語を更新し、ignore は保持します。
既存の項目を消去せずに用語集の行をインポートします。Merge は一致する用語を更新し、ignore は保持します。
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/glossary_import
```
## 認証と権限
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
必要な権限: `glossary:write`.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
## パラメーター
トランスポート境界では任意です。省略すると、検証前にサーバーが識別子を補完します。レスポンスを受信できなかった場合に安全に復旧できるよう、固定の UUID v4 を指定してください。
形式: "uuid". パターン: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
テキスト値。
最小文字数: 2. 最大文字数: 64.
テキスト値。
許容値: "merge", "replace", "ignore". デフォルト値: "merge".
値のリスト。要素の構造は完全な入力スキーマを参照してください。
最小要素数: 1. 最大要素数: 500.
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
```json theme={null}
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
},
"sourceLanguage": {
"type": "string",
"minLength": 2,
"maxLength": 64
},
"importMode": {
"default": "merge",
"type": "string",
"enum": ["merge", "replace", "ignore"]
},
"rows": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"rowNumber": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"sourceText": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"targets": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 2,
"maxLength": 64
},
"additionalProperties": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 2000
},
"mode": {
"type": "string",
"enum": ["translate", "keep"]
},
"applicationMode": {
"type": "string",
"enum": ["smart", "strict"]
}
},
"required": ["text", "mode"],
"additionalProperties": false
}
}
},
"required": ["rowNumber", "sourceText", "targets"],
"additionalProperties": false
}
}
},
"required": ["sourceLanguage", "rows"],
"additionalProperties": false
}
```
## 冪等性
変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。
すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。
## リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","importMode":"merge","rows":[{"rowNumber":1,"sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}]}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
sourceLanguage: 'english',
importMode: 'merge',
rows: [
{
rowNumber: 1,
sourceText: 'Product',
targets: {
french: {
text: 'Produit',
mode: 'translate',
applicationMode: 'smart',
},
},
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "importMode": "merge", "rows": [{"rowNumber": 1, "sourceText": "Product", "targets": {"french": {"text": "Produit", "mode": "translate", "applicationMode": "smart"}}}]},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。
インポートした行数、処理後のエントリー数、および無効またはスキップされた行を含むインポート概要を返します。
```json HTTP 200 theme={null}
{
"data": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
```
## 結果フィールド
| フィールド | 説明 |
| - | - |
| `data.glossaryId` | インポートした用語集の識別子。 |
| `data.sourceLanguage` | 正規化済みの元言語。 |
| `data.importedCount` | インポート保存処理に渡された有効な行数。 |
| `data.entryCount` | インポート後に用語集に保存されているエントリの総数。 |
| `data.invalidRows` | 無効またはスキップされた行。rowNumber、任意の sourceText、reason を含みます。 |
| `data.invalidRows[].rowNumber` | 送信したペイロード内の行識別子。 |
| `data.invalidRows[].sourceText` | 取得可能な場合の元用語。 |
| `data.invalidRows[].reason` | 行が無効またはスキップされた理由。 |
| `data.importMode` | 指定したモード。デフォルトは merge です。 |
## リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。resultStored が false の場合は、対応する履歴、結果、またはダウンロードアクションで出力を取得します。進捗を確認するためだけに、別の生成を開始しないでください。
```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"glossary_import"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
}
}
}
```
## 操作の注意事項
* 1–500 件の構造化された行を受け付けます。各行には 1–200 の翻訳先言語を指定できます。各 target オブジェクトには text と mode が必要です。
* デフォルトは merge です。ignore は既存の元用語をスキップし、invalidRows に報告します。
* 現在の実装では replace を受け付けますが、同じ merge 操作で保存します。ペイロードから省略されたエントリーは削除しません。既存の用語集を消去する目的で replace に依存しないでください。
* 重複する原語や不明な翻訳先言語は、無効な行として報告されます。有効な行が残らない場合、リクエストは失敗します。
* 行の翻訳先で applicationMode を省略すると、現在のインポート処理はその翻訳先に strict を割り当てます。モードの指定が重要な場合は、smart または strict を明示してください。
## 使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。
## エラー
| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `BAD_REQUEST` | 検証後に有効な用語集の行が残っていません。 |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `GLOSSARY_IMPORT_UNKNOWN_LANGUAGE` | インポート元の言語は未対応です。 |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key ヘッダーとリクエストボディの requestId は一致させる必要があります。 |
| 400 | `INVALID_REQUEST_ID` | UUID v4 の requestId または Idempotency-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 | `ACCOUNT_UNAVAILABLE` | 操作を実行するアカウントまたは請求対象アカウントが利用できないか、削除中です。 |
| 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` | アカウントまたはアクティブなワークスペースのアカウントが見つかりませんでした。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | アクションは実行されましたが、結果を保存できませんでした。新しい生成を開始する前に、保存済みリクエストの状態とリソース履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["glossary:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.