用語集の項目を作成または更新

curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_entry_upsert' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  sourceLanguage: 'english',
  sourceText: 'Product',
  targets: {
    french: {
      text: 'Produit',
      mode: 'translate',
      applicationMode: 'smart',
    },
  },
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_entry_upsert', {
  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/glossary_entry_upsert",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "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": {
    "glossaryId": "user_123__english",
    "sourceLanguage": "english",
    "entry": {
      "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
      "sourceText": "product",
      "targets": {
        "french": {
          "text": "Produit",
          "mode": "translate",
          "applicationMode": "smart"
        }
      },
      "createdAt": 1792152000000,
      "updatedAt": 1792152000000
    }
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "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"
}

POST

actions

glossary_entry_upsert

curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_entry_upsert' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  sourceLanguage: 'english',
  sourceText: 'Product',
  targets: {
    french: {
      text: 'Produit',
      mode: 'translate',
      applicationMode: 'smart',
    },
  },
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_entry_upsert', {
  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/glossary_entry_upsert",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "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": {
    "glossaryId": "user_123__english",
    "sourceLanguage": "english",
    "entry": {
      "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
      "sourceText": "product",
      "targets": {
        "french": {
          "text": "Produit",
          "mode": "translate",
          "applicationMode": "smart"
        }
      },
      "createdAt": 1792152000000,
      "updatedAt": 1792152000000
    }
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "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"
}

原文の用語とその翻訳を作成または置き換えます。項目を変更できるのは用語集の所有者のみです。

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

認証と権限

string

必須

このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP でのみ使用でき、この REST エンドポイントでは使用できません。

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

パラメーター

string

トランスポート境界では任意です。省略すると、検証前にサーバーが識別子を補完します。レスポンスを受信できなかった場合に安全に復旧できるよう、固定の 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}$.

string

必須

テキスト値。最小文字数: 2. 最大文字数: 64.

string

必須

テキスト値。最小文字数: 1. 最大文字数: 500.

object

必須

JSON オブジェクト。ネストされたフィールドは完全な入力スキーマを参照してください。

完全な入力スキーマ

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

{
  "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
    },
    "sourceText": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "targets": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 2,
        "maxLength": 64
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "object",
            "properties": {
              "text": {
                "type": "string",
                "maxLength": 2000
              },
              "mode": {
                "type": "string",
                "enum": ["translate", "keep"]
              },
              "applicationMode": {
                "type": "string",
                "enum": ["smart", "strict"]
              }
            },
            "required": ["text"],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": ["sourceLanguage", "sourceText", "targets"],
  "additionalProperties": false
}

冪等性

変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。

リクエスト例

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

curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_entry_upsert' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}'

const input = {
  requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
  sourceLanguage: 'english',
  sourceText: 'Product',
  targets: {
    french: {
      text: 'Produit',
      mode: 'translate',
      applicationMode: 'smart',
    },
  },
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_entry_upsert', {
  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/glossary_entry_upsert",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "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 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。正規化済みの元用語と翻訳先ルールを含む、保存済みエントリーを返します。

{
  "data": {
    "glossaryId": "user_123__english",
    "sourceLanguage": "english",
    "entry": {
      "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
      "sourceText": "product",
      "targets": {
        "french": {
          "text": "Produit",
          "mode": "translate",
          "applicationMode": "smart"
        }
      },
      "createdAt": 1792152000000,
      "updatedAt": 1792152000000
    }
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "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.entry.entryId`	保存済みエントリの識別子。原語の用語を変更すると変わる場合があります。
`data.entry.sourceText`	用語集が返す、前後の空白除去・小文字化済みの元用語。
`data.entry.targets`	正規化された翻訳先言語名から翻訳ルールへのマップ。
`data.entry.targets.<language>.text`	その翻訳先言語で使用するテキスト。
`data.entry.targets.<language>.mode`	translate または keep。
`data.entry.targets.<language>.applicationMode`	対象ルールに保存する場合は smart または strict。
`data.entry.createdAt`	保存処理が返すエントリー作成タイムスタンプ（ミリ秒）。
`data.entry.updatedAt`	エントリの保存タイムスタンプ（ミリ秒）。

リクエストの復旧とポーリング

接続が切断された後も同じ識別子を使用してください。resultStored が false の場合は、対応する履歴、結果、またはダウンロードアクションで出力を取得します。進捗を確認するためだけに、別の生成を開始しないでください。

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_entry_upsert"}'

HTTP 200

{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "glossaryId": "user_123__english",
      "sourceLanguage": "english",
      "entry": {
        "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
        "sourceText": "product",
        "targets": {
          "french": {
            "text": "Produit",
            "mode": "translate",
            "applicationMode": "smart"
          }
        },
        "createdAt": 1792152000000,
        "updatedAt": 1792152000000
      }
    }
  }
}

操作の注意事項

1–200 の翻訳先言語を受け付けます。各対象には、文字列、または text、任意の mode、任意の applicationMode を含むオブジェクトを指定できます。
ソース用語は1–500文字、対象テキストは最大2,000文字です。
原語は保存と項目識別のため、前後の空白が除去され、小文字化されます。後の更新や削除には、返された entryId を使用してください。
空の翻訳先は無視されます。空でない翻訳先が少なくとも 1 つ残る必要があります。原語と同じ翻訳先テキストは keep モードで保存されます。

使用量

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

エラー

HTTP ステータス	コード	意味または対処方法
400	`BAD_REQUEST`	ソース言語または対象言語が未対応、または正規化後に空でない対象翻訳が残っていません。
400	`CREDENTIAL_IN_QUERY`	access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。
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`	サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["glossary:write"]
  }
}

概要

ディスカバリー

アカウント

使用量とアクティビティ

設定と通知

チーム

プロジェクト

翻訳と吹き替え

文字起こしと編集

テキスト読み上げ

読み上げ音声

吹き替え音声

文字起こし

字幕とキャプション

画像

サムネイル

フォルダー

用語集

Webhook

公開

リクエストの状態

OAuth と MCP プロトコル

用語集の項目を作成または更新

認証と権限

パラメーター

冪等性

リクエスト例

レスポンス

結果フィールド

リクエストの復旧とポーリング

操作の注意事項

使用量

エラー

​認証と権限

​パラメーター

​冪等性

​リクエスト例

​レスポンス

​結果フィールド

​リクエストの復旧とポーリング

​操作の注意事項

​使用量

​エラー

認証と権限

パラメーター

冪等性

リクエスト例

レスポンス

結果フィールド

リクエストの復旧とポーリング

操作の注意事項

使用量

エラー