Notiondesk API を使用すると、ヘルプセンターで提供する言語を変更したり、デフォルト言語を選択したり、AI による自動翻訳をオン/オフしたりできます。この API を使用すると、複数のヘルプセンターに新しい言語を展開したり、言語設定を独自の構成と同期させたりできます。
| 方法 | パス | 範囲 | する |
|---|---|---|---|
PATCH | /sites/{site_id}/settings/supported-languages | write | 提供される言語とデフォルト言語を設定します |
PATCH | /sites/{site_id}/settings/auto-translate | write | 自動翻訳のオン/オフを切り替え、翻訳元の言語を設定します。 |
どちらのルートも 204 No Content に応答します。__ ND_TERM_5bcd8dee__ API を使用してヘルプ センターを読み取る方法の説明に従って、GET /sites/{site_id} を使用して新しい状態を読み取ります。
ヘルプセンターで利用できる言語を設定してください。
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/supported-languages" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"locales": ["en", "fr", "de"], "default_locale": "en"}'| 分野 | タイプ | 注記 | 読み返し |
|---|---|---|---|
locales | 文字列のリスト | ヘルプセンターが対応しているすべての言語で、少なくとも1つは必要です。それぞれヘルプセンターのavailable_localesのいずれかである必要があります。 | supported_locales |
default_locale | 弦 | 読者がフォールバックする言語。結果の言語でなければならず、nullであってはなりません。 | default_locale |
省略したフィールドは、現在の値を保持します。
locales リスト全体が置き換えられます。リストから言語を除外すると、ヘルプセンターからその言語に関する設定(ページタイトルや説明など)もすべて削除されます。言語を追加するには、まずリストを読み、新しい言語を追加した状態で送信してください。supported_localesJavaScriptでも同様の機能を追加し、既存の言語を維持します。
プラン制限
プランでは、ヘルプセンターが対応できる言語の数を設定しています。それより長いlocalesリストは、403 permission_deniedに応答します。
ヘルプセンターがsupported_localesに表示されていない言語を保存している場合、送信内容に関わらず、このルートへのすべてのリクエストに対して403 permission_deniedが返されます。これは次のような場合に発生します。
const siteId = "c74781f6-1aea-4e17-ab23-bbb8b4d174b6";
const headers = {
Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
"nd-version": "2026-10-16",
"Content-Type": "application/json",
};
const site = await (await fetch(`https://api.notiondesk.so/sites/${siteId}`, { headers })).json();
const locales = [...new Set([...site.supported_locales, "de"])];
await fetch(`https://api.notiondesk.so/sites/${siteId}/settings/supported-languages`, {
method: "PATCH",
headers,
body: JSON.stringify({ locales }),
});- ヘルプセンターには、プランで許可されている言語数よりも多くの言語が登録されている場合があります(例えば、プランをダウングレードした場合など)。
- 保存されている言語が無効になっています。
- デフォルト言語には保存された設定がなく、プランの枠を1つ占有します。
ダッシュボードでヘルプセンターの言語を変更してください。APIは、表示できない言語を保護するために変更を拒否します。デフォルト言語のみを変更するリクエストでは、それらの言語とその設定が削除されてしまうためです。 ヘルプセンターで複数の言語をサポートする方法については、「ヘルプセンターで複数の言語をサポートする」を参照してください。
自動翻訳をオンまたはオフにする
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/auto-translate" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"auto_translate_enabled": true, "auto_translate_source_locale": "en"}'| 分野 | タイプ | 注記 |
|---|---|---|
auto_translate_enabled | ブール値 | 不足している翻訳が自動的に生成されるかどうか |
auto_translate_source_locale | 文字列またはnull | 自動翻訳が読み取る言語。ヘルプセンターのsupported_localesのいずれかである必要があります。nullでクリアされます。 |
JSONブール値trueまたはfalseを送信してください。0と"false"はtrueとして読み取られ、課金対象の翻訳が有効になります。
自動翻訳をオンにすると、ヘルプセンターの翻訳が開始されます。初回は、ワークスペースの翻訳料金も自動的に課金されます。ご利用のプランに自動翻訳が含まれている必要があります。AI自動翻訳の利用方法については、「AI自動翻訳の利用開始」をご覧ください。
法案の翻訳は、
| アクション | 翻訳されたもの |
|---|---|
| 言語を追加する | ヘルプセンターのコンテンツを新しい言語に翻訳します。 |
| スケジュールされた同期、またはトリガーされた同期 | 同期によってソース言語で変更されたコンテンツ、およびまだ翻訳されていないもの |
| Notionにアップロードされたファイルを含む記事を同期する | その記事の自動翻訳された言語すべて、テキストは変更されていない。 |
同期がどのように変換されるかについては、 「トリガー Notion が Notiondesk API と同期する」を参照してください。
エラー
| 状態 | いつ | code |
|---|---|---|
| 400 | locales が空であるか、利用できない言語が含まれている場合、default_locale が null であるか、結果として得られる言語に含まれていない場合、auto_translate_source_locale がヘルプセンターの言語の 1 つでない場合、または本文に不明なフィールドがある場合 | validation_error |
| 403 | キーにはwriteスコープがありません | insufficient_scope |
| 403 | プランで使用できる言語数が多すぎる、保存されている言語が非表示になっている(プランの制限を参照)、プランに自動翻訳が含まれていない、またはキーの作成者がこのヘルプセンターを変更できない | permission_denied |
| 404 | ヘルプセンターはワークスペースに存在しません | not_found |
エラーエンベロープおよびその他のコードについては、 「Notiondesk API エラー、レート制限、および再試行の処理」を参照してください。
よくある質問
他の言語を削除せずに、新しい言語を追加するにはどうすればよいですか?
ヘルプセンターのsupported_localesを読んで、新しい言語を追加し、リスト全体をlocalesとして送信してください。ルートは、送信した内容でリストを置き換えます。
どの言語コードが使えますか?
ヘルプセンターのavailable_localesにあるもので、GET /sites/{site_id}によって返されます。
APIを使って記事を1つだけ翻訳することはできますか?
いいえ。自動翻訳は、有効になっている間はヘルプセンター全体で実行され、同期のたびに変更された箇所が翻訳されます。API は、自動翻訳のオン/オフを切り替え、ソース言語を設定します。
言語を削除すると、Notion 内のその言語に関連する記事も削除されますか?
いいえ。APIはNotionのコンテンツを変更することはありません。言語を削除すると、ヘルプセンターがその言語の情報を提供しなくなり、その言語に関するヘルプセンターの設定も削除されます。