Skip to content

armgit / xerj

Public Imported from GitHub
0

AI search engine and MCP server for bots and agents. One Rust binary indexes code, docs, logs, JSONL/CSV and PDFs for BM25 full-text, vector and hybrid search, code search without grep, agent memory and RAG. Elasticsearch-compatible API; Corpus Hub serves hundreds of reference memory corpora.

39.4 KB
Raw Blame
<!DOCTYPE html>
<html lang="en" data-theme="day">
<head>
<!-- ga4:begin — generated by scripts/seo/seo_head.py · do not hand-edit -->
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-Z77ETCDJYL"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'G-Z77ETCDJYL');
</script>
<!-- ga4:end -->
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>XERJ · Docs · For AI · Agent quickstart</title>
<meta name="description" content="Agent quickstart: boot XERJ, store a memory, recall it by meaning, and run a semantic search — every step a runnable curl against :9200.">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Big+Shoulders+Display:wght@400;700;800;900&family=Inter:wght@400;500;600;700&family=IBM+Plex+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;700&display=swap" rel="stylesheet">
<link rel="icon" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'><rect width='100' height='100' fill='%230b0b0d'/><text x='50' y='68' font-size='60' font-family='Big Shoulders Display,sans-serif' font-weight='900' fill='%23ffc400' text-anchor='middle'>X</text></svg>">
<script src="/theme.js"></script>
<link rel="stylesheet" href="/style.css?v=90f643e">
<!-- seo:begin — generated by scripts/seo/fix_heads.py · do not hand-edit -->
<link rel="canonical" href="https://xerj.org/docs/agents/quickstart">
<meta property="og:site_name" content="XERJ.ai">
<meta property="og:type" content="article">
<meta property="og:title" content="XERJ · Docs · For AI · Agent quickstart">
<meta property="og:description" content="Agent quickstart: boot XERJ, store a memory, recall it by meaning, and run a semantic search — every step a runnable curl against :9200.">
<meta property="og:url" content="https://xerj.org/docs/agents/quickstart">
<meta property="og:image" content="https://xerj.org/og/xerj-card.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta property="og:image:alt" content="XERJ.ai — the search engine built for AI agents">
<meta property="og:locale" content="en_US">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="XERJ · Docs · For AI · Agent quickstart">
<meta name="twitter:description" content="Agent quickstart: boot XERJ, store a memory, recall it by meaning, and run a semantic search — every step a runnable curl against :9200.">
<meta name="twitter:image" content="https://xerj.org/og/xerj-card.png">
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "@id": "https://xerj.org/#organization",
  "name": "XERJ",
  "alternateName": "XERJ.ai",
  "url": "https://xerj.org/",
  "logo": "https://xerj.org/brandbook/xerj-mark.svg",
  "description": "A new way for AI to search for data: one local Rust binary that indexes your code, docs, specs and logs, plus Corpus Hub packs, and returns cited answers.",
  "sameAs": [
    "https://github.com/xerj-org/xerj",
    "https://x.com/xerj_org"
  ]
}
</script>
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "WebSite",
  "@id": "https://xerj.org/#website",
  "name": "XERJ.ai",
  "url": "https://xerj.org/",
  "inLanguage": "en",
  "publisher": {
    "@id": "https://xerj.org/#organization"
  }
}
</script>
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "TechArticle",
  "headline": "XERJ · Docs · For AI · Agent quickstart",
  "description": "Agent quickstart: boot XERJ, store a memory, recall it by meaning, and run a semantic search — every step a runnable curl against :9200.",
  "url": "https://xerj.org/docs/agents/quickstart",
  "image": "https://xerj.org/og/xerj-card.png",
  "inLanguage": "en",
  "datePublished": "2026-07-08",
  "dateModified": "2026-09-08",
  "author": {
    "@id": "https://xerj.org/#organization"
  },
  "publisher": {
    "@id": "https://xerj.org/#organization"
  },
  "isPartOf": {
    "@id": "https://xerj.org/#website"
  },
  "mainEntityOfPage": {
    "@type": "WebPage",
    "@id": "https://xerj.org/docs/agents/quickstart"
  }
}
</script>
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [
    {
      "@type": "ListItem",
      "position": 1,
      "name": "Home",
      "item": "https://xerj.org/"
    },
    {
      "@type": "ListItem",
      "position": 2,
      "name": "Docs",
      "item": "https://xerj.org/docs/"
    },
    {
      "@type": "ListItem",
      "position": 3,
      "name": "For AI",
      "item": "https://xerj.org/docs/agents/"
    },
    {
      "@type": "ListItem",
      "position": 4,
      "name": "Agent quickstart"
    }
  ]
}
</script>
<!-- seo:end -->
</head>
<body>


<nav class="nav" aria-label="Primary">
  <a href="/" class="brand">XERJ</a>
  <a href="/product">PRODUCT</a>
  <a href="/use-cases">USE CASES</a>
  <a href="/answers/">ANSWERS</a>
  <a href="/benchmarks/">BENCHMARKS</a>
  <a href="/blog/">BLOG</a>
  <span class="spacer"></span>
  <a href="/for-agents">FOR AGENTS</a>
  <a href="/docs/" class="active">DOCS</a>
  <a href="/playground">DASHBOARDS</a>
  <a href="https://hub.xerj.org" rel="external">HUB</a>
  <a class="nav-stars" href="https://github.com/xerj-org/xerj" rel="external" title="XERJ on GitHub" aria-label="XERJ on GitHub, 14,225 stars"><svg viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/></svg><span class="nav-stars-n" data-gh-stars="14225">★ 14.2k</span></a>
  <a href="https://x.com/xerj_org" rel="external" title="XERJ on X" style="display:inline-flex;align-items:center"><svg width="15" height="15" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M18.244 2.25h3.308l-7.227 8.26 8.502 11.24H16.17l-5.214-6.817L4.99 21.75H1.68l7.73-8.835L1.254 2.25H8.08l4.713 6.231zm-1.161 17.52h1.833L7.084 4.126H5.117z"/></svg></a>
  <a href="https://discord.com/invite/yetXFusXfs" rel="external" title="XERJ on Discord" style="display:inline-flex;align-items:center"><svg width="15" height="15" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M20.317 4.37a19.79 19.79 0 00-4.885-1.515.074.074 0 00-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 00-5.487 0 12.64 12.64 0 00-.617-1.25.077.077 0 00-.079-.037A19.74 19.74 0 003.677 4.37a.07.07 0 00-.032.027C.533 9.046-.32 13.58.099 18.057a.082.082 0 00.031.057 19.9 19.9 0 005.993 3.03.078.078 0 00.084-.028c.462-.63.874-1.295 1.226-1.994a.076.076 0 00-.041-.106 13.1 13.1 0 01-1.872-.892.077.077 0 01-.008-.128 10.2 10.2 0 00.372-.292.074.074 0 01.077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 01.078.01c.12.098.246.198.373.292a.077.077 0 01-.006.127 12.3 12.3 0 01-1.873.892.077.077 0 00-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 00.084.028 19.84 19.84 0 006.002-3.03.077.077 0 00.032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 00-.031-.03zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418z"/></svg></a>
  <span class="theme">
    <button type="button" data-theme="day" class="active">DAY</button>
    <span class="dash">·</span>
    <button type="button" data-theme="night">NIGHT</button>
  </span>
</nav>

<div class="docs-search" id="docsSearch">
  <input type="text" id="docsSearchInput" placeholder="Search docs · keys, flags, endpoints, playbooks…" aria-label="Search docs" autocomplete="off" spellcheck="false">
  <span class="hint">⌘ K</span>
  <div class="results" id="docsSearchResults" aria-live="polite"></div>
</div>

<div class="docs-shell">
<nav class="docs-nav" aria-label="Docs">  <div class="group">
    <span class="label">FOR AI · AGENTS</span>
    <a href="/for-agents" class=""><span class="eyebrow">00</span>For AI (hub)</a>
      <a href="/docs/agents/" class=""><span class="eyebrow">01</span>Overview</a>
      <a href="/docs/agents/quickstart" class="active"><span class="eyebrow">02</span>Agent quickstart</a>
      <a href="/docs/agents/endpoints" class=""><span class="eyebrow">03</span>Endpoint contract</a>
  </div>
  <div class="group">
    <span class="label">START</span>
    <a href="/docs/" class=""><span class="eyebrow">01</span>Overview</a>
      <a href="/docs/quickstart" class=""><span class="eyebrow">02</span>Quickstart</a>
      <a href="/docs/install" class=""><span class="eyebrow">03</span>Install</a>
      <a href="/docs/migration-from-es" class=""><span class="eyebrow">04</span>Migrate from ES</a>
  </div>
  <div class="group">
    <span class="label">REFERENCE</span>
    <a href="/docs/cli" class=""><span class="eyebrow">01</span>CLI</a>
      <a href="/docs/config" class=""><span class="eyebrow">02</span>Config TOML</a>
      <a href="/docs/env" class=""><span class="eyebrow">03</span>Environment</a>
      <a href="/docs/api-native" class=""><span class="eyebrow">04</span>Native REST API</a>
      <a href="/docs/api-es-compat" class=""><span class="eyebrow">05</span>ES-compat API</a>
  </div>
  <div class="group">
    <span class="label">DATA MODEL</span>
    <a href="/docs/queries" class=""><span class="eyebrow">01</span>Query types</a>
      <a href="/docs/aggregations" class=""><span class="eyebrow">02</span>Aggregations</a>
      <a href="/docs/analyzers" class=""><span class="eyebrow">03</span>Analyzers</a>
      <a href="/docs/vectors" class=""><span class="eyebrow">04</span>Vectors & kNN</a>
  </div>
  <div class="group">
    <span class="label">ENGINE</span>
    <a href="/docs/ingest" class=""><span class="eyebrow">01</span>Ingest pipelines</a>
      <a href="/docs/storage" class=""><span class="eyebrow">02</span>Storage & WAL</a>
      <a href="/docs/compression" class=""><span class="eyebrow">03</span>Compression</a>
      <a href="/docs/clustering" class=""><span class="eyebrow">04</span>Clustering</a>
      <a href="/docs/metrics" class=""><span class="eyebrow">05</span>Metrics</a>
      <a href="/docs/security" class=""><span class="eyebrow">06</span>Auth & TLS</a>
  </div>
  <div class="group">
    <span class="label">OPERATIONS</span>
    <a href="/docs/operations" class=""><span class="eyebrow">01</span>Running in production</a>
      <a href="/docs/backup-restore" class=""><span class="eyebrow">02</span>Backup & restore</a>
      <a href="/docs/upgrades" class=""><span class="eyebrow">03</span>Upgrades</a>
      <a href="/docs/troubleshooting" class=""><span class="eyebrow">04</span>Troubleshooting</a>
  </div>
  <div class="group">
    <span class="label">RECIPES</span>
    <a href="/docs/recipes/" class=""><span class="eyebrow">00</span>All recipes</a>
    <a href="/docs/recipes/semantic-search-rag" class=""><span class="eyebrow">01</span>Semantic search &amp; RAG</a>
    <a href="/docs/recipes/agentic-memory" class=""><span class="eyebrow">02</span>Agent memory</a>
    <a href="/docs/recipes/hybrid-search" class=""><span class="eyebrow">06</span>Hybrid search</a>
    <a href="/docs/recipes/vector-search-knn" class=""><span class="eyebrow">04</span>Vector search &middot; kNN</a>
  </div>
</nav>

<main class="docs-content">
  <!-- Print-only branded header (hidden on screen, visible in PDF) -->
  <div class="print-header" style="display:none;">XERJ</div>

  <div class="breadcrumb"><a href="/docs/">DOCS</a><span class="sep">·</span><a href="/docs/agents/">FOR AI</a><span class="sep">·</span>AGENT QUICKSTART
    <button class="pdf-btn" onclick="window.print()" title="Save this page as PDF">
      <svg viewBox="0 0 24 24"><path d="M12 3v12M12 15l-4-4M12 15l4-4"/><path d="M4 17v2a2 2 0 002 2h12a2 2 0 002-2v-2"/></svg>
      PDF
    </button>
  </div>
  <div class="kicker"><span>FOR AI · 02</span></div>
  <h1>Agent quickstart</h1>

  <p>Five steps, all runnable, all on port <code class="inline">9200</code>: <strong>boot XERJ → check it is up → store a memory → recall it by meaning → run a semantic search.</strong> Every request and every response below is a real run against a freshly booted, empty XERJ — no seeding, no external embedding service, no API key. If you have <code class="inline">curl</code>, you have everything.</p>

  <h2>0 · Boot XERJ</h2>
  <p>One binary. <code class="inline">--insecure</code> disables TLS and API-key auth so you can talk to it over plain HTTP on the default ES-compat port <code class="inline">9200</code> — perfect for a local agent loop. Install it first (<code class="inline">curl -fsSL https://xerj.org/get | sh</code> on Linux, macOS, and Windows Git Bash, MSYS and Cygwin; <code class="inline">irm https://xerj.org/get.ps1 | iex</code> in PowerShell). The <code class="inline">sh</code> installer puts <code class="inline">xerj</code> in <code class="inline">~/.local/bin</code> (<code class="inline">xerj.exe</code> on Windows) and prints the exact path if that is not on your <code class="inline">PATH</code>. The PowerShell installer puts <code class="inline">xerj.exe</code> in <code class="inline">%LOCALAPPDATA%\Programs\xerj</code> and adds that directory to the user PATH.</p>
<pre class="code"># start it in the background — a foreground boot blocks the rest of this page
$ xerj --insecure --data-dir /tmp/xerj-agent &amp;

# then WAIT for it: an agent that fires the next request immediately gets a connection refused
$ until curl -sf localhost:9200/_cluster/health &gt;/dev/null; do sleep 0.3; done</pre>
  <p>Keep the data dir <strong>outside</strong> any folder you intend to index later — pointing <code class="inline">xerj autoindex</code> at a tree that contains the node's own storage indexes the engine's files. New to XERJ? The <a href="/docs/install">install page</a> has one-line downloads for every platform, and the <a href="/docs/recipes/zero-config-autoindex">zero-config indexing recipe</a> is the next step after this page.</p>

  <h2>1 · Confirm it is up</h2>
  <p>The root path returns the ES-style info document. Any Elasticsearch client uses this as its handshake — which is exactly why an off-the-shelf ES client library points at XERJ unchanged.</p>
<pre class="code">$ curl -s localhost:9200/
{"name":"local","cluster_name":"xerj",
 "cluster_uuid":"xerj-cluster-0000-0000-0000-000000000000",
 "version":{"number":"8.13.0","build_flavor":"default","build_type":"tar",
            "lucene_version":"9.10.0", ... },
 "tagline":"You Know, for Search"}</pre>
  <p>Want the cluster's health instead? <code class="inline">GET /_cluster/health</code> returns <code class="inline">{"status":"green", ...}</code> on a healthy single node.</p>

  <h2>2 · Store a memory</h2>
  <p>An agent learns something worth keeping. Store it in a per-agent namespace — here <code class="inline">agent-demo</code>. You do <strong>not</strong> create the namespace first; it is created on the first store. You do <strong>not</strong> supply a vector; because the memory's <code class="inline">text</code> is a <code class="inline">semantic_text</code> field, XERJ auto-embeds it with its built-in embedder at store time.</p>
<pre class="code">$ curl -sXPOST localhost:9200/_memory/agent-demo \
    -H 'content-type: application/json' \
    -d '{
      "text": "The user prefers metric units and a dark UI theme.",
      "metadata": {"kind": "preference"}
    }'
{"created":true,"id":"77eff57b-e432-431c-8b49-8a16b33ab551","namespace":"agent-demo"}</pre>
  <p>Store a second one so recall has something to rank against:</p>
<pre class="code">$ curl -sXPOST localhost:9200/_memory/agent-demo \
    -H 'content-type: application/json' \
    -d '{"text":"The production database is Postgres 16 in us-east-1.","metadata":{"kind":"fact"}}'
{"created":true,"id":"ddaecb5f-61ab-4b57-bc31-82a118e6131c","namespace":"agent-demo"}</pre>

  <h2>3 · Recall by meaning</h2>
  <p>On a later turn the agent asks a question that shares <em>no keywords</em> with the stored memory. Set <code class="inline">"semantic": true</code> and pass the raw question as <code class="inline">query</code>: XERJ embeds it with the same built-in embedder used at store time and ranks memories by vector similarity.</p>
<pre class="code">$ curl -sXPOST localhost:9200/_memory/agent-demo/_recall \
    -H 'content-type: application/json' \
    -d '{
      "query": "what display settings does the user like?",
      "semantic": true,
      "k": 2
    }'
{"hits":[
   {"id":"77eff57b-e432-431c-8b49-8a16b33ab551",
    "metadata":{"kind":"preference"},
    "score":0.655571460723877,
    "text":"The user prefers metric units and a dark UI theme."},
   {"id":"ddaecb5f-61ab-4b57-bc31-82a118e6131c",
    "metadata":{"kind":"fact"},
    "score":0.5951915979385376,
    "text":"The production database is Postgres 16 in us-east-1."}],
 "namespace":"agent-demo"}</pre>
  <p>The UI-preference memory ranks first for a question about "display settings" it shares no words with. Two other recall modes use the same endpoint:</p>
  <ul>
    <li><strong>Keyword (BM25):</strong> drop <code class="inline">"semantic": true</code> and just send <code class="inline">{"query":"database"}</code> — exact-word relevance over the stored text.</li>
    <li><strong>Vector (kNN):</strong> send <code class="inline">{"vector":[…]}</code> to recall against embeddings you supplied at store time.</li>
    <li><strong>Metadata filter:</strong> add <code class="inline">"filter":{"term":{"metadata.kind":"preference"}}</code> to narrow any recall to a subset — nested metadata fields are queryable with no extra mapping.</li>
  </ul>

  <h2>4 · Semantic search over your own documents</h2>
  <p>Memory is one store; your own indices are another. Give a field the <code class="inline">semantic_text</code> type and XERJ auto-embeds it on ingest into a companion vector, so a <code class="inline">semantic</code> query retrieves by meaning. First create the index:</p>
<pre class="code">$ curl -sXPUT localhost:9200/notes \
    -H 'content-type: application/json' \
    -d '{"mappings":{"properties":{"body":{"type":"semantic_text"}}}}'
{"acknowledged":true,"shards_acknowledged":true,"index":"notes"}</pre>
  <p>Index a few documents. <strong>Note the verbs:</strong> an <em>explicit</em> id uses <code class="inline">PUT&nbsp;/notes/_doc/{id}</code>; an <em>auto</em> id uses <code class="inline">POST&nbsp;/notes/_doc</code>. (Sending <code class="inline">POST</code> to an explicit-id path is the one easy mistake — it will not index.)</p>
<pre class="code">$ curl -sXPUT localhost:9200/notes/_doc/1 -H 'content-type: application/json' \
    -d '{"body":"How do I roll back a bad deployment?"}'
$ curl -sXPUT localhost:9200/notes/_doc/2 -H 'content-type: application/json' \
    -d '{"body":"Reverting a broken release to the previous version."}'
$ curl -sXPUT localhost:9200/notes/_doc/3 -H 'content-type: application/json' \
    -d '{"body":"Configuring TLS certificates for the ingress."}'
$ curl -sXPOST localhost:9200/notes/_refresh</pre>
  <p>Now search by meaning. The query text <em>"undo a failed rollout"</em> shares no words with any document, yet the rollback note wins:</p>
<pre class="code">$ curl -sXPOST localhost:9200/notes/_search \
    -H 'content-type: application/json' \
    -d '{
      "query": {"semantic": {"field": "body", "query": "undo a failed rollout", "k": 2}},
      "_source": ["body"]
    }'
{"hits":{"total":{"value":2,"relation":"eq"},
  "hits":[
    {"_id":"2","_score":0.5531777143478394,
     "_source":{"body":"Reverting a broken release to the previous version."}},
    {"_id":"1","_score":0.53...,
     "_source":{"body":"How do I roll back a bad deployment?"}}]}}</pre>
  <p>The <code class="inline">"Configuring TLS certificates"</code> note is correctly excluded. Filter <code class="inline">_source</code> to the fields you want — the auto-generated companion embedding lives in a <code class="inline">body_vector</code> field and is otherwise part of <code class="inline">_source</code>, so scoping it keeps responses small.</p>

  <h2>Going further — vector &amp; hybrid</h2>
  <p>If you already have embeddings, add a <code class="inline">dense_vector</code> field and run <code class="inline">knn</code> — HNSW-served with exact rescoring when unfiltered, an exact scan when filtered or on a small index; to combine keyword and vector recall in a single call, use a <code class="inline">hybrid</code> query with <code class="inline">rrf</code> fusion. Both are shown, with response shapes, on the <a href="/docs/agents/endpoints">endpoint contract</a>. For worked, end-to-end walkthroughs see the recipes: <a href="/docs/recipes/agentic-memory">agent memory</a>, <a href="/docs/recipes/semantic-search-rag">semantic search &amp; RAG</a>, <a href="/docs/recipes/hybrid-search">hybrid search</a>.</p>

  <h2>Clean up</h2>
  <p>Drop the memory namespace and the demo index when you are done:</p>
<pre class="code">$ curl -sXDELETE localhost:9200/_memory/agent-demo
{"dropped":true,"namespace":"agent-demo"}
$ curl -sXDELETE localhost:9200/notes
{"acknowledged":true}</pre>

  <div class="next">
      <div class="step"><span class="dir">◀ PREV</span><a href="/docs/agents/">For AI · Overview</a></div>
      <div class="step right"><span class="dir">NEXT ▶</span><a href="/docs/agents/endpoints">Endpoint contract</a></div>
    </div>

  <!-- Print-only branded footer (hidden on screen, visible in PDF) -->
  <div class="print-footer" style="display:none;">
    <span>XERJ.AI · FOR AI · AGENT QUICKSTART</span>
    <a href="https://xerj.org/docs/agents/quickstart">https://xerj.org/docs/agents/quickstart</a>
    <span>Agent quickstart</span>
  </div>
</main>

</div>

<!-- seo:footer-begin — generated by scripts/seo/fix_links.py · do not hand-edit -->
<nav class="footer-map" aria-label="Site map">
  <div class="fm-col">
    <span class="fm-h">PRODUCT</span>
    <a href="/product">PRODUCT</a>
    <a href="/architecture/">ARCHITECTURE</a>
    <a href="/benchmarks/">BENCHMARKS</a>
    <a href="/pricing/">PRICING</a>
    <a href="/security/">SECURITY</a>
    <a href="/playground">DASHBOARDS</a>
    <a href="/demo/">REAL-DATA DEMO</a>
    <a href="/aise-demo">PRODUCT TOUR</a>
  </div>
  <div class="fm-col">
    <span class="fm-h">LEARN</span>
    <a href="/answers/">ANSWERS</a>
    <a href="/compare/">COMPARE</a>
    <a href="/use-cases">USE CASES</a>
    <a href="/case-studies">CASE STUDIES</a>
    <a href="/industries/">INDUSTRIES</a>
    <a href="/blog/">BLOG</a>
  </div>
  <div class="fm-col">
    <span class="fm-h">SOLUTIONS</span>
    <a href="/solutions/">SOLUTIONS</a>
    <a href="/industries/finserv">FINANCIAL SERVICES</a>
    <a href="/industries/public-sector">PUBLIC SECTOR</a>
    <a href="/industries/healthcare">HEALTHCARE</a>
    <a href="/industries/retail">RETAIL</a>
    <a href="/use-cases/code-security-audit">AI CODE-SECURITY AUDIT</a>
    <a href="/use-cases/semantic-analytics">SEMANTIC ANALYTICS</a>
    <a href="/resources/">SALES KIT</a>
  </div>
  <div class="fm-col">
    <span class="fm-h">DOCS</span>
    <a href="/docs/">DOCUMENTATION</a>
    <a href="/docs/quickstart">QUICKSTART</a>
    <a href="/docs/install">INSTALL</a>
    <a href="/docs/migration-from-es">MIGRATE FROM ELASTICSEARCH</a>
    <a href="/docs/recipes/">RECIPES</a>
    <a href="/docs/agents/">DOCS FOR AI</a>
    <a href="/for-agents">FOR AI AGENTS</a>
    <a href="/agent-search/">AGENTIC SEARCH DEMO</a>
    <a href="/llms.txt">LLMS.TXT</a>
    <a href="https://github.com/xerj-org/xerj" rel="external">GITHUB</a>
  </div>
</nav>
<!-- seo:footer-end -->
<footer class="footer">
  <span>XERJ.AI · DOCS · V1.0.0-RC.100</span>
  <span>READ THE SOURCE</span>
  <span><a href="/">HOME</a> · <a href="/product">PRODUCT</a> · <a href="/answers/">ANSWERS</a> · <a href="/playground">DASHBOARDS</a> &middot; <a href="/llms.txt">LLMS.TXT</a></span>
</footer>

<script type="application/json" id="docs-index">[{"title":"Overview","slug":"/docs/","kicker":"START","snip":""},{"title":"Quickstart","slug":"/docs/quickstart","kicker":"START","snip":""},{"title":"Install","slug":"/docs/install","kicker":"START","snip":""},{"title":"Migrate from ES","slug":"/docs/migration-from-es","kicker":"START","snip":""},{"title":"CLI","slug":"/docs/cli","kicker":"REFERENCE","snip":""},{"title":"Config TOML","slug":"/docs/config","kicker":"REFERENCE","snip":""},{"title":"Environment","slug":"/docs/env","kicker":"REFERENCE","snip":""},{"title":"Native REST API","slug":"/docs/api-native","kicker":"REFERENCE","snip":""},{"title":"ES-compat API","slug":"/docs/api-es-compat","kicker":"REFERENCE","snip":""},{"title":"Query types","slug":"/docs/queries","kicker":"DATA MODEL","snip":""},{"title":"Aggregations","slug":"/docs/aggregations","kicker":"DATA MODEL","snip":""},{"title":"Analyzers","slug":"/docs/analyzers","kicker":"DATA MODEL","snip":""},{"title":"Vectors & kNN","slug":"/docs/vectors","kicker":"DATA MODEL","snip":""},{"title":"Ingest pipelines","slug":"/docs/ingest","kicker":"ENGINE","snip":""},{"title":"Storage & WAL","slug":"/docs/storage","kicker":"ENGINE","snip":""},{"title":"Compression","slug":"/docs/compression","kicker":"ENGINE","snip":""},{"title":"Clustering","slug":"/docs/clustering","kicker":"ENGINE","snip":""},{"title":"Metrics","slug":"/docs/metrics","kicker":"ENGINE","snip":""},{"title":"Auth & TLS","slug":"/docs/security","kicker":"ENGINE","snip":""},{"title":"Running in production","slug":"/docs/operations","kicker":"OPERATIONS","snip":""},{"title":"Backup & restore","slug":"/docs/backup-restore","kicker":"OPERATIONS","snip":""},{"title":"Upgrades","slug":"/docs/upgrades","kicker":"OPERATIONS","snip":""},{"title":"Troubleshooting","slug":"/docs/troubleshooting","kicker":"OPERATIONS","snip":""},{"title":"SIEM","slug":"/docs/playbooks/siem","kicker":"PLAYBOOKS","snip":""},{"title":"Log analytics","slug":"/docs/playbooks/log-analytics","kicker":"PLAYBOOKS","snip":""},{"title":"Vector · RAG","slug":"/docs/playbooks/vector-search","kicker":"PLAYBOOKS","snip":""},{"title":"Full-text search","slug":"/docs/playbooks/full-text","kicker":"PLAYBOOKS","snip":""},{"title":"Observability","slug":"/docs/playbooks/observability","kicker":"PLAYBOOKS","snip":""},{"title":"CLI · --config","slug":"/docs/cli#config-flag","kicker":"CLI","snip":"-c, --config <PATH>  Path to the TOML config file."},{"title":"CLI · --data-dir","slug":"/docs/cli#data-dir-flag","kicker":"CLI","snip":"-d, --data-dir <PATH>  Override [server] data_dir at the command line."},{"title":"CLI · --insecure","slug":"/docs/cli#insecure-flag","kicker":"CLI","snip":"-k, --insecure  Disable TLS and API-key auth. Dev only."},{"title":"[server] rest_port","slug":"/docs/config#server","kicker":"CONFIG","snip":"u16 · default 8080 · Native REST API listener port."},{"title":"[server] es_compat_port","slug":"/docs/config#server","kicker":"CONFIG","snip":"u16 · default 9200 · Elasticsearch-wire-format port. 0 = OS-assigned port."},{"title":"[storage] wal_sync","slug":"/docs/config#storage","kicker":"CONFIG","snip":"enum · default batched · sync · batched · async. Durability knob."},{"title":"[vector] hnsw_ef_search","slug":"/docs/config#vector","kicker":"CONFIG","snip":"u32 · default 100 · Accepted but not wired — the beam width comes from the request num_candidates."},{"title":"[vector] default_quantization","slug":"/docs/config#vector","kicker":"CONFIG","snip":"enum · none (default) · scalar8. binary is refused at startup; scalar4 is not accepted."},{"title":"GET /v1/health","slug":"/docs/api-native#health","kicker":"NATIVE API","snip":"Liveness + readiness. {status, uptime_s, version}."},{"title":"GET /v1/metrics","slug":"/docs/api-native#metrics","kicker":"NATIVE API","snip":"Prometheus text format. Scrape-friendly."},{"title":"POST /v1/indices/:name/turbo-ingest","slug":"/docs/api-native#turbo-ingest","kicker":"NATIVE API","snip":"NDJSON bulk path with parallel tokenization."},{"title":"POST /v1/indices/:name/search","slug":"/docs/api-native#search","kicker":"NATIVE API","snip":"Unified query endpoint — full-text, term, range, KNN, hybrid."},{"title":"POST /:index/_bulk","slug":"/docs/api-es-compat#bulk","kicker":"ES API","snip":"NDJSON bulk. Actions: index, create, update, delete."},{"title":"POST /:index/_search","slug":"/docs/api-es-compat#search","kicker":"ES API","snip":"ES query DSL. Drop-in migration path."},{"title":"match_all","slug":"/docs/queries#match-all","kicker":"QUERY","snip":"Everything in the index."},{"title":"bool","slug":"/docs/queries#bool","kicker":"QUERY","snip":"must / should / must_not / filter clauses."},{"title":"knn","slug":"/docs/queries#knn","kicker":"QUERY","snip":"Vector kNN — HNSW-served when unfiltered (exact-rescored); filtered runs the exact scan."},{"title":"semantic","slug":"/docs/queries#semantic","kicker":"QUERY","snip":"Embed the query text at query time and search the vector field."},{"title":"hybrid","slug":"/docs/queries#hybrid","kicker":"QUERY","snip":"RRF / linear fusion of sub-queries."},{"title":"terms aggregation","slug":"/docs/aggregations#terms","kicker":"AGG","snip":"Exact, pre-computed terms histograms over keyword fields."},{"title":"date_histogram","slug":"/docs/aggregations#date-histogram","kicker":"AGG","snip":"Time-bucketed counts."},{"title":"kNN serving","slug":"/docs/vectors#knn-query","kicker":"VECTORS","snip":"Unfiltered kNN via persisted HNSW + exact rescore; filtered kNN exact scan."},{"title":"SQ8 quantization","slug":"/docs/vectors#quantization","kicker":"VECTORS","snip":"8-bit scalar quantization. int8 scoring precision, not a memory saving (#392)."},{"title":"turbo-ingest","slug":"/docs/ingest#turbo","kicker":"INGEST","snip":"NDJSON bulk path. Parallel tokenization across cores."},{"title":"delta-of-delta","slug":"/docs/compression#delta-of-delta","kicker":"COMPRESSION","snip":"Timestamp encoding. Apache/Nginx/ISO auto-detect."},{"title":"dictionary encoding","slug":"/docs/compression#dictionary","kicker":"COMPRESSION","snip":"Up to 256 unique strings per column."},{"title":"api_key","slug":"/docs/security#api-key","kicker":"SECURITY","snip":"Static admin key. Auto-generated on first run."},{"title":"SIEM playbook","slug":"/docs/playbooks/siem","kicker":"PLAYBOOK","snip":"Terms agg over source IPs for SIEM, with detection rules."},{"title":"RAG playbook","slug":"/docs/playbooks/vector-search","kicker":"PLAYBOOK","snip":"Embeddings, kNN, hybrid search, BM25 + kNN fusion."},{"title":"[cluster] enabled","slug":"/docs/config#cluster","kicker":"CONFIG","snip":"bool · default false · Enable multi-node Raft cluster mode."},{"title":"[cluster] peers","slug":"/docs/config#cluster","kicker":"CONFIG","snip":"array · \"host:port=host:port\" · label must equal address (#1171)."},{"title":"[cluster] port","slug":"/docs/config#cluster","kicker":"CONFIG","snip":"u16 · default 9300 · Intra-cluster Raft + search port."},{"title":"[embedding] default_endpoint","slug":"/docs/config#embedding","kicker":"CONFIG","snip":"string · OpenAI-compatible embeddings URL for auto-embedding on ingest."},{"title":"[embedding] default_model","slug":"/docs/config#embedding","kicker":"CONFIG","snip":"string · Model name (e.g. text-embedding-3-small, nomic-embed-text)."},{"title":"Raft","slug":"/docs/clustering","kicker":"CLUSTER","snip":"Embedded Raft — leader election, log replication, metadata only."},{"title":"Node draining","slug":"/docs/clustering","kicker":"CLUSTER","snip":"POST /v1/cluster/nodes/:id/drain before maintenance."},{"title":"Region split/merge","slug":"/docs/clustering","kicker":"CLUSTER","snip":"Range partitions auto-split at byte threshold, merge back when small."},{"title":"Systemd unit","slug":"/docs/operations","kicker":"OPS","snip":"Production unit file with hardening directives."},{"title":"Readiness probe","slug":"/docs/operations","kicker":"OPS","snip":"GET /v1/health/ready — only 200 once WAL replay is complete."},{"title":"Config reload","slug":"/docs/operations","kicker":"OPS","snip":"SIGHUP reloads most keys without restart."},{"title":"Hot backup","slug":"/docs/backup-restore","kicker":"OPS","snip":"rsync the data dir after POST /v1/admin/flush."},{"title":"S3 backup","slug":"/docs/backup-restore","kicker":"OPS","snip":"POST /v1/admin/backup → any S3-compatible endpoint."},{"title":"Rolling upgrade","slug":"/docs/upgrades","kicker":"OPS","snip":"Drain → stop → upgrade → start → activate, per node."},{"title":"Merge pressure","slug":"/docs/troubleshooting","kicker":"OPS","snip":"Segment count climbing → raise merge.max_concurrent + io_rate."},{"title":"Cluster flapping","slug":"/docs/troubleshooting","kicker":"OPS","snip":"Leader changes every few seconds → raise cluster.tick_ms."},{"title":"WAL warnings after a crash","slug":"/docs/troubleshooting","kicker":"OPS","snip":"Repaired on startup; no manual repair command."},{"title":"Recipes","slug":"/docs/recipes/","kicker":"RECIPES","snip":"Task-oriented AI & search recipes, each verified end-to-end against a live XERJ."},{"title":"Semantic search & RAG","slug":"/docs/recipes/semantic-search-rag","kicker":"RECIPE","snip":"Retrieval by meaning with semantic_text — auto-embed on ingest, no separate vector DB."},{"title":"Agent memory","slug":"/docs/recipes/agentic-memory","kicker":"RECIPE","snip":"Long-term memory for agents via /_memory — store, recall, forget, per-agent isolation."},{"title":"Passage retrieval","slug":"/docs/recipes/passage-retrieval","kicker":"RECIPE","snip":"Auto-chunk long docs; best-passage (max-sim) scoring — 98% top-3."},{"title":"Vector search · kNN","slug":"/docs/recipes/vector-search-knn","kicker":"RECIPE","snip":"Nearest-neighbor over dense_vector — HNSW-served unfiltered, exact with filters."},{"title":"Vector quantization","slug":"/docs/recipes/vector-quantization","kicker":"RECIPE","snip":"scalar8 (accepts ES int8_hnsw; exact code scan) — int8 scoring at recall@10 = 0.998. Precision, not memory."},{"title":"Hybrid search","slug":"/docs/recipes/hybrid-search","kicker":"RECIPE","snip":"Keyword + vector in one query — RRF fusion."},{"title":"Log analytics","slug":"/docs/recipes/log-analytics","kicker":"RECIPE","snip":"Raw logs to dashboards — error rates, p95 latency, top services."},{"title":"Anomaly detection","slug":"/docs/recipes/anomaly-detection","kicker":"RECIPE","snip":"Statistical _ml detectors that flag spikes in metrics/logs."},{"title":"Anomaly datafeeds","slug":"/docs/recipes/continuous-anomaly-datafeeds","kicker":"RECIPE","snip":"Live _ml datafeed re-scores an index on a timer, stores anomaly records."},{"title":"Migrate from ES","slug":"/docs/recipes/migrate-from-elasticsearch","kicker":"RECIPE","snip":"Point your existing ES client at XERJ — same wire, change the URL."},{"title":"For AI · Build with XERJ","slug":"/for-agents","kicker":"AI","snip":"The search, data & memory layer for AI agents — one binary on :9200."},{"title":"Agents · Overview","slug":"/docs/agents/","kicker":"AI","snip":"The 7 canonical agent ops: autoindex (CLI-only), search, semantic, vector, hybrid, memory store/recall."},{"title":"Agent quickstart","slug":"/docs/agents/quickstart","kicker":"AI","snip":"Boot XERJ, store a memory, recall by meaning, semantic search — runnable curl on :9200."},{"title":"Agent endpoints","slug":"/docs/agents/endpoints","kicker":"AI","snip":"Endpoint contract table: method, path, request body, response shape."},{"title":"xerj_memory_store","slug":"/docs/agents/endpoints#memory-store","kicker":"AGENT OP","snip":"POST /_memory/{ns} — store a memory (text auto-embedded, or bring your own vector)."},{"title":"xerj_memory_recall","slug":"/docs/agents/endpoints#memory-recall","kicker":"AGENT OP","snip":"POST /_memory/{ns}/_recall — recall top-k by meaning (semantic), keyword (BM25) or vector (kNN)."},{"title":"xerj_semantic_search","slug":"/docs/agents/endpoints#semantic","kicker":"AGENT OP","snip":"semantic query over a semantic_text field — the server embeds the query text."},{"title":"xerj_autoindex","slug":"/docs/recipes/zero-config-autoindex","kicker":"AGENT OP","snip":"xerj autoindex <folder> — CLI-only, no HTTP route: content-sniffed formats, inferred mappings, self-describing catalog."},{"title":"xerj_vector_search","slug":"/docs/agents/endpoints#vector","kicker":"AGENT OP","snip":"knn over dense_vector — HNSW-served when unfiltered (exact-rescored), exact scan when filtered."},{"title":"xerj_hybrid_search","slug":"/docs/agents/endpoints#hybrid","kicker":"AGENT OP","snip":"hybrid query — fuse BM25 + vector with rrf or linear fusion."}]</script>

<script>
  // IIFE — js-auth navigates between decrypted pages in the same
  // JS realm, so const bindings must be lexically scoped.
  (function () {
    const root = document.documentElement;

    // Client-side docs search — filters the inline JSON index.
    const searchEl    = document.getElementById('docsSearch');
    const inputEl     = document.getElementById('docsSearchInput');
    const resultsEl   = document.getElementById('docsSearchResults');
    const indexJson   = document.getElementById('docs-index');
    if (searchEl && inputEl && resultsEl && indexJson) {
      let index = [];
      try { index = JSON.parse(indexJson.textContent || '[]'); } catch {}
      const render = (q) => {
        const query = q.trim().toLowerCase();
        if (!query) { searchEl.classList.remove('active'); resultsEl.innerHTML = ''; return; }
        const scored = [];
        for (const e of index) {
          const hay = (e.title + ' ' + (e.kicker || '') + ' ' + (e.snip || '')).toLowerCase();
          if (hay.includes(query)) {
            let score = 0;
            if (e.title.toLowerCase().includes(query)) score += 10;
            if ((e.kicker || '').toLowerCase() === query.toUpperCase()) score += 5;
            if ((e.snip || '').toLowerCase().includes(query)) score += 1;
            scored.push({ e, score });
          }
        }
        scored.sort((a, b) => b.score - a.score);
        const top = scored.slice(0, 20);
        if (top.length === 0) {
          resultsEl.innerHTML = '<div class="no-results">NO MATCHES — TRY A SHORTER QUERY</div>';
        } else {
          resultsEl.innerHTML = top.map(({e}) => {
            const kicker = e.kicker || '';
            const snip = e.snip ? '<div class="snip">' + escHtml(e.snip) + '</div>' : '';
            return '<a href="' + e.slug + '">' +
              '<span class="kicker">' + escHtml(kicker) + '</span>' +
              '<span class="title">' + escHtml(e.title) + '</span>' +
              snip + '</a>';
          }).join('');
        }
        searchEl.classList.add('active');
      };
      const escHtml = (s) => String(s).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
      inputEl.addEventListener('input', (e) => render(e.target.value));
      inputEl.addEventListener('focus', () => { if (inputEl.value) render(inputEl.value); });
      document.addEventListener('keydown', (e) => {
        if ((e.key === 'k' || e.key === 'K') && (e.metaKey || e.ctrlKey)) {
          e.preventDefault();
          inputEl.focus();
          inputEl.select();
        }
        if (e.key === 'Escape' && document.activeElement === inputEl) {
          inputEl.value = '';
          searchEl.classList.remove('active');
          resultsEl.innerHTML = '';
          inputEl.blur();
        }
      });
    }
  })();
</script>


</body>
</html>