Skip to main content

LLM エージェント向けクイックスタート

3 つの API 呼び出しで:全メモリの再取得、新規保存、検索。LLM の必須ワークフロー。


LLM エージェント向けクイックスタート

セッション間ですべてのメモリを失います。Synapse はあなたの外部脳です。本ガイドはすべての LLM エージェントが知っておくべき 3 つの必須 API 呼び出しを示します。

**毎セッションの開始時に** `GET /memory/recall` を呼び出してください。 これを呼び出さないと、ユーザーが誰か、何を約束したか、前回何を作業していたかの記憶がありません。

ステップ 1:全メモリの再取得(常に最初に)

GET /memory/recall
Authorization: Bearer YOUR_MIND_KEY

保存された全メモリの構造化されたプレーンテキスト要約を返します。これを解析して、ユーザー、プロジェクト、過去のやり取りのメンタルモデルを再構築します。

レスポンス例:

Mind: Michael's Mind
Memories: 12 total (10 verified)

[001] identity (CRITICAL)
  user_name
  Michael Schäfer
  Tags: person, identity

[002] preference (HIGH)
  communication_style
  Prefers concise technical responses, no fluff
  Tags: communication, preference

[003] project (HIGH)
  project_synapse
  Synapse v1.5.0 deployed on vps1.schaefer.zone. Admin panel at /admin.
  Tags: synapse, deployment
  ...

ステップ 2:新規メモリの保存

記憶する価値のあることを学んだら:

POST /memory
Authorization: Bearer YOUR_MIND_KEY
Content-Type: application/json

{
  "category": "fact",
  "key": "user_name",
  "content": "The user's name is Michael Schäfer",
  "tags": ["person", "identity"],
  "priority": "critical"
}

カテゴリ: identitypreferencefactprojectskillmistakecontextnote

優先度: lownormalhighcritical

常に `key` フィールドを含めてください — メモリの短い識別子です。同じキーで再 POST することで、後から同じメモリを更新できます。

ステップ 3:特定メモリの検索

GET /memory/search?q=Docker+Swarm
Authorization: Bearer YOUR_MIND_KEY
FTS5 構文:複数単語 = AND 検索。フレーズは引用符:`"docker swarm"`。プレフィックス検索:`docker*`。ブール:`docker OR kubernetes`。

オープンツール(認証ヘッダーなし)

ツールが URL しか開けない場合(カスタムヘッダーなし)、?key= パラメータを使用します。

GET /memory/recall?key=YOUR_MIND_KEY
POST /memory?key=YOUR_MIND_KEY (+ JSON body)
GET /memory/search?key=YOUR_MIND_KEY&q=suchbegriff
`?key=` は 60 リクエスト/分にレート制限されます。Bearer ヘッダーにはレート制限がありません。可能な限り Bearer ヘッダーを使用してください。

完全なセッションワークフロー

  1. セッション開始: GET /memory/recall — 全メモリを読み込む
  2. 作業中: GET /memory/search?q=... — 特定の事実を検索
  3. 新情報: POST /memory — 保存(category、key、tags、priority を指定)
  4. 定期的に: GET /chat/poll — 人間のメッセージを確認
  5. セッション終了: 最終的な学習内容を POST /memory で保存

よくあるパターン

既存メモリの更新

同じ categorykeyPOST /memory を呼び出すと、重複ではなく既存メモリが更新されます。

プロジェクトステータスの保存

{
  "category": "project",
  "key": "project_synapse_status",
  "content": "Synapse v1.5.0 deployed. Next: v1.6.0 with docs system. CI green.",
  "tags": ["synapse", "deployment", "status"],
  "priority": "high"
}

過ちの記録(繰り返しを避けるため)

{
  "category": "mistake",
  "key": "mistake_npm_version_bump",
  "content": "Always bump package.json version after changes — npm publish fails otherwise.",
  "tags": ["npm", "ci", "deployment"],
  "priority": "high"
}

人間のメッセージの確認

GET /chat/poll
Authorization: Bearer YOUR_MIND_KEY

人間からの未読メッセージを返します。以下で返信:

POST /chat/reply
Authorization: Bearer YOUR_MIND_KEY
Content-Type: application/json

{"content": "Got it! Working on it now."}

次のステップ