API Reference
API overview
There are three ways in from outside OS iXanagi: MCP, for reading your knowledge from the AI tools you use; webhooks, for receiving events; and the API keys they use.
API Reference4 pages
Contents3 chapters
Three ways in
- MCP — a connection for reading your company's knowledge and strategy from AI tools such as Claude or ChatGPT. Read-only.
- Webhooks — notifications to your server when something happens: knowledge created or updated, a workflow finished, and so on.
- API keys — the keys you use for both. You issue them in the console.
What we promise
- A key can only do what the person who issued it may do. A key is never stronger than its owner.
- A key sees only its own company's data. Naming another company's brand or site gets "not found".
- Breaking changes and removals are announced in advance. See the API Terms for details.
Reading errors
- 401 — no key, or the key cannot be used (revoked or expired).
- 403 — the key or its owner lacks permission for the operation.
- 404 — the target does not exist, or does not belong to your company.
- 422 — the input has the wrong shape.
- 429 — too many requests in a short time. Wait a moment and retry.
- 503 — the request cannot be decided right now and is stopped for safety. Wait a moment and retry.