Skip to main content

Quick Start Guide

The fastest way to use KnowledgeFlowDB is now the docs app itself: sign in with Privy, let the browser mint the bearer + derive session, and run live queries immediately.

1. Sign In with Privy​

Open docs.knowledgeflowdb.org or db.knowledgedataflow.org and sign in.

You do not need to manually paste:

  • a wallet address
  • an API endpoint
  • an API key

The hosted flow uses:

  1. Privy login
  2. wallet-backed bearer auth
  3. sign-to-derive session establishment
  4. automatic attachment of auth headers on requests

2. Run Your First Query​

Visit KQL Syntax and click Run Query after signing in.

The page will automatically:

  • mint a bearer token if needed
  • mint a derive session if needed
  • send:
Authorization: Bearer <token>
x-derive-session-id: <session_id>
x-derive-key: <derive_key_hex>

Recommended first commands:

SHOW LABELS
SHOW PROPERTIES
HELP

3. Explore the Schema​

These discovery commands are the best way to orient yourself in a fresh tenant:

SHOW LABELS
SHOW EDGE_TYPES
SHOW PROPERTIES File
SHOW SCHEMA

4. Query Data with KQL​

Example:

MATCH (n:File)
RETURN n.path, n.language
LIMIT 10

5. Query Data with SQL​

SQL runs against the source-of-truth query path:

SELECT COUNT(*) AS total
FROM nodes_by_label
WHERE label = 'File'

The docs-site SQL playground now sends these requests to:

POST /api/v1/query/sql

Programmatic Access​

If you are building your own client instead of using the interactive docs:

That is the advanced path. It is no longer the primary onboarding story for the hosted docs experience.

Advanced Debug Mode​

The query playground still exposes an advanced connection drawer for:

  • non-default KFDB endpoints
  • explicit bearer tokens
  • explicit derive session/key values

That drawer is for debugging and custom environments. The normal experience should be Privy-first.

Next Steps​