API リファレンス
API の全体像
OS iXanagi の外から使える入口は 3 つです。お使いの AI ツールから知識を読む MCP、出来事を受け取る Webhook、そしてそれらに使う API キーです。
API リファレンス全 4 ページ
目次全 3 章
3 つの入口
- MCP — Claude や ChatGPT などの AI ツールから、あなたの会社の知識や戦略を読むための接続です。読み取り専用です。
- Webhook — 知識が作られた・更新された、ワークフローが終わった、といった出来事を、あなたのサーバーへ知らせます。
- API キー — 上の 2 つを使うための鍵です。コンソールで発行します。
約束していること
- 鍵で呼べるのは、鍵を発行した人の権限の内側までです。鍵が持ち主より強くなることはありません。
- 見えるのは、その鍵の会社のデータだけです。ほかの会社のブランドやサイトを名指ししても「見つからない」と答えます。
- 互換性のない変更や提供の終了は、事前に知らせます。詳しくは API 利用規約をご覧ください。
エラーの読み方
- 401 — 鍵が無い、または使えない（失効・期限切れ）。
- 403 — 鍵か持ち主に、その操作の権限がない。
- 404 — 対象が無い、または自分の会社のものではない。
- 422 — 入力の形が正しくない。
- 429 — 短い時間に送りすぎた。少し待ってから送り直してください。
- 503 — いまは判定できない。安全のため止めています。少し待ってから送り直してください。