コンテンツにスキップ
Vessios Docs
日本語
Esc
navigateopen⌘Jpreview
このページの内容

連携

Vessios を自動化・拡張するための API キー・Webhook・コネクタ。

API キー

サーバー間連携には、セッショントークンの代わりに API キーを発行できます。

  • POST /api-keys — キーを作成する。キーは viewer または editor 権限にスコープされ(admin/owner には発行できません)、API キーが権限昇格に使われることはありません。
  • GET /api-keys — キー一覧を取得する。
  • DELETE /api-keys/{key_id} — キーを失効させる。

各リクエストの X-Api-Key ヘッダーにキーを送信します。キーは SHA-256 ハッシュとして保存され、作成後に生の値が再表示されることはないため、作成時に安全な場所へ保管してください。

Webhook

テナント内でイベントが発生した際に通知を受け取る Webhook を登録できます。

  • POST /webhooks — Webhook URL を登録する。
  • GET /webhooks — 登録済みの Webhook 一覧。
  • GET /webhooks/sample — 連携前にサンプルペイロードを確認する。
  • DELETE /webhooks/{webhook_id} — Webhook を削除する。

現在対応しているイベントは ingest.completed(Ingest 実行完了時に発火)です。すべての配信は HMAC-SHA256 で署名されており、Vessios から送信されたものであることを検証できます。また、すべての Webhook URL は登録時・送信時の両方で SSRF 防御によって検証されます。

Slack

Vessios は Slack へ通知を投稿できるほか、Slack 上で直接質問された内容にも、Web UI と同じ Query パイプラインで回答できます。Slack 連携の設定・テストは POST /settings/slack/test から行えます。

コネクタ

Vessios は、管理者が制御するスケジュールで外部ナレッジツールからコンテンツを取り込めます。

  • NotionPOST /admin/connectors/notion/tokenPOST /admin/connectors/notion/sync で接続・同期します。同期された Notion ページはそれぞれ1件の Ingest になります。
  • ConfluencePOST /admin/connectors/confluence/tokenPOST /admin/connectors/confluence/sync で接続・同期します。

コネクタの同期は現時点では管理者によるトリガーが必要で、完全な自動化ではありません。両コネクタとも、リクエストが別の場所へリダイレクトされないよう接続先ホストを検証します。

エクスポート

wiki 全体を他ツールで利用するためにエクスポートできます。

  • POST /exportllms.txtllms-full.txtllmstxt.org 準拠。wiki を下流の LLM ワークフローに供給する用途)、または graphml(グラフ可視化ツール向け)としてエクスポート。

このページは役に立ちましたか?