Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flumes.ai/llms.txt

Use this file to discover all available pages before exploring further.

1

Get an API key

Sign up at app.flumes.ai and grab your secret key from the dashboard.
2

Assemble context for a turn (optionally ingest)

curl -s https://api.flumes.ai/v0/context/assemble \
  -H "Authorization: Bearer $FLUMES_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Flumes-Agent: demo" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "entity_id": "ent:user_123",
    "turn": "I want to go to Rome in July. Any museum tips?",
    "retrieval": { "preset": "balanced" },
    "ingest": { "extract": false },
    "return": {
      "include_structured_facts": true,
      "include_raw_matches": true,
      "include_scores": true
    },
    "max_context_tokens": 1200
  }'
3

Recall explicitly (optional)

curl -s https://api.flumes.ai/v0/recall \
  -H "Authorization: Bearer $FLUMES_API_KEY" \
  -H "Content-Type": "application/json" \
  -d '{
    "query": "museums in Rome",
    "entity_id": "ent:user_123",
    "return": { "include_structured_facts": true, "include_scores": true },
    "limit": 8
  }'
That’s it! You now have a persistent memory layer for your app. Explore the auto-generated API to dive deeper.