メンバーのメモリ管理 API
ログイン済みメンバーが API を通じて自身の永続的な記憶を管理する方法を説明します。
ログイン済みのメンバーは、/api/me/memories/ を通じて自身の記憶を確認・管理できます。リクエストには X-Organization-Id を含め、現在操作する組織を指定してください。サービスは、その組織におけるログインユーザーの有効なメンバー資格に基づいてデータを取得します。ログイン方法と共通のリクエスト方法については、クイックスタートを参照してください。
利用可能な操作
一覧表示
GET /api/me/memories/
現在のメンバーの active と expired の記憶を一覧表示します。status と kind のクエリパラメータで絞り込めます。
作成
POST /api/me/memories/
自身の記憶を作成します。同じメンバーに同じ topic の有効な記憶がすでにある場合は、その記憶を更新します。新規作成時は HTTP 201、更新時は HTTP 200 を返します。
編集または再有効化
PATCH /api/me/memories/{id}/
表示可能な記憶を編集するか、status を active または expired に設定します。
削除
DELETE /api/me/memories/{id}/
自身の指定した記憶を削除します。
作成時には topic、summary、details が必須です。topic は最大 100 文字で、小文字の英字、数字、および文字の間のアンダースコアのみ使用できます。summary は最大 500 文字です。details は最大 20 項目で、各項目は最大 500 文字です。kind には fact、preference、instruction を指定できます。省略した場合は fact になります。
連携時の状態の扱い
メンバーが記憶を expired に設定しても、連携先は一覧で確認し、PATCH で active に戻せます。有効なメンバー資格がない場合、記憶の作成は HTTP 404 を返します。異なる組織のデータが同じ画面に混在しないよう、連携先ではリクエストで指定した組織に対応する記憶を表示してください。
最終更新
役に立ちましたか?