API ドキュメント¶
API を認証するには、OAuth2 または API キー のいずれかを使用できます。OAuth2 は、アプリケーションがシステム内の特定のドキュメントに安全にアクセスできるようにする標準の認可フレームワークです。一方、API キーは、OAuth2 認証プロセスを経ることなく、共通の知識ベースからドキュメントを取得するためのより簡単な方法を提供します。
API 概要¶
Rememberizer は、ドキュメント、ベクターストア、メメントなどを扱うための包括的な API セットを提供します。API は以下のカテゴリに整理されています：
認証API¶
- サインアップ、サインイン、メール認証
- パスワードリセット
- OAuthエンドポイント（Google、Microsoft）
- トークン管理とログアウト
ユーザーAPI¶
- ユーザープロフィールとアカウント情報
- ユーザーオンボーディング
ドキュメントAPI¶
- ドキュメントの一覧、作成、更新
- ドキュメント処理
- バッチドキュメント操作
検索API¶
- 基本検索
- エージェント検索
- バッチ検索操作
メメント API¶
- メメントの作成、一覧表示、更新、削除
- メメントドキュメントの管理
ベクトルストアAPI¶
- ベクトルストアの作成と一覧表示
- テキストおよびファイルドキュメントのアップロード
- ベクトルストアの検索
- バッチアップロードと検索
インテグレーション API¶
- インテグレーションのリスト
- OAuth インテグレーション エンドポイント (Google Drive, Gmail, Slack, Dropbox)
アプリケーション API¶
- アプリケーションの一覧と作成
共通知識API¶
- 共通知識アイテムのリストと作成
チームAPI¶
- チーム管理
- チームメンバー
- ロールベースの権限
エンタープライズ統合パターン、セキュリティの考慮事項、およびアーキテクチャのベストプラクティスについては、エンタープライズ統合パターンガイドを参照してください。
ベースURL¶
すべてのAPIエンドポイントは次の相対パスです：
認証¶
エンドポイントは、次のいずれかを使用して認証を必要とします： - JWTトークン（Authorizationヘッダーまたはクッキーに渡される） - APIキー（x-api-keyヘッダーに渡される）
特定のエンドポイントに関する詳細情報については、個別のAPIドキュメントページを参照してください。