XTrace SDK documentation

What is XTrace?

Traditional vector databases require you to hand your data to a third party in plaintext. XTrace is different: your document content is AES-encrypted and your embedding vectors are homomorphically encrypted before they leave your machine. The server stores and searches over ciphertexts — computing nearest-neighbor Hamming distances directly on encrypted vectors — without ever seeing the underlying data. When results come back, you decrypt them locally.

This means you get semantic search with the same privacy guarantees as if the data never left your laptop.

The SDK has two modules: x-vec for encrypted vector search, and x-mem for encrypted agent memory (coming soon). Both share the same credentials, execution context, and XTrace integration.

Getting started

Note

Create a free account at app.xtrace.ai to get your API key and org ID. The free tier is rate-limited but fully functional.

Choose your path:

• Python SDK — Installation then x-vec Tutorial for a concept-first walkthrough with full code examples.

• CLI — Installation then XTrace CLI Quick Start for a terminal-first workflow that gets you querying in four commands.

Getting Started

• Installation
  • Base install
  • Optional extras
  • Install from source
• x-vec Tutorial
  • How it works
  • Core concepts
  • Prerequisites
  • Step 1 — Create an execution context
  • Step 2 — Set up embedding and connect to XTrace
  • Step 3 — Encrypt and store documents
  • Step 4 — Query
  • Next steps

x-vec

• Embedding Models
  • Ollama
  • Sentence Transformers
  • OpenAI
  • Bring Your Own Vectors
• Using the XTrace Managed Service
  • Security Model
  • Execution Context
  • Connecting
  • Loading Data
  • Querying
  • Metadata Search
  • Chunk Operations
  • Execution Context Management
  • Notes
• LLM Inference
  • OpenAI
  • Anthropic (Claude)
  • Redpill
  • Ollama
• Metadata Filtering
  • Privacy Notice
  • Metadata Fields
  • Supported Operators
  • Query Examples

x-mem

• x-mem (Coming Soon)
  • Planned features

CLI

• XTrace CLI Quick Start
  • Install dependencies
  • Using the CLI
  • Initialize SDK
  • Key concepts
  • Your first query
  • Command groups
• CLI Command Reference
  • Shared commands
  • Knowledge base admin — xtrace kb
  • x-vec commands — xtrace xvec
  • x-mem commands — xtrace xmem

Reference

• Configuration
  • Cryptography Configuration
  • Execution Context Configuration
  • DataLoader Configuration
  • Retriever Configuration
  • Environment Variables
• Changelog
  • [0.1.0] - 2026-03-14
• Contribution Guide
  • Contributing

API Reference

• API Reference

Indices and tables

• Index

• Module Index

• Search Page