Documentation

Technical documentation.

Guides for runtime setup, project state, approved memory, context compilation, capabilities, provider adapters, agents, synchronization, and verification.

START

Quickstart

Create a local identity, establish a project, compile context, and invoke a compatible provider.

GUIDES

Core concepts

Understand authority, canonical state, memory with source provenance, capabilities, and checkpoints.

REFERENCE

API and SDK

Explore runtime APIs, external endpoints, schemas, rejection codes, and integration contracts.

Local quickstart

Run the broker, copy its scoped client capability, and connect from the workspace. Provider credentials stay in the broker process.

# choose configured adapters
export OPENAI_API_KEY=…
export ANTHROPIC_API_KEY=…
export GEMINI_API_KEY=…
export XAI_API_KEY=…
export OLLAMA_BASE_URL=http://127.0.0.1:11434

cargo run -p wclmfenx-api

# broker
http://127.0.0.1:8787

Durable broker

Run the same broker behind your HTTPS endpoint. A master key seals authority, memory, capabilities, and provider state before every atomic storage commit. Remote startup is refused when durable state is absent.

# random 32 byte base64url key
export WCLMFENX_MASTER_KEY=…
export WCLMFENX_STATE_FILE=/var/lib/wclmfenx/runtime.sealed
export WCLMFENX_CAPABILITY_FILE=/var/lib/wclmfenx/client.capability
export WCLMFENX_LISTEN=0.0.0.0:8787

docker compose -f deploy/docker-compose.yml up -d

Encrypted device sync

Create a sync space from the workspace and enroll another browser with the recovery key. Encryption and device signing keys remain nonextractable inside the browser. The relay stores only ciphertext, authenticated history links, device public keys, and revocation state.

Atomic history

Each update names the previous commitment and expected revision. Conflicting writers pull, merge deterministically, and retry without discarding either branch.

Device authority

Every request is signed with a device key, timestamp, and unique request identity. Replays and revoked devices are rejected before storage access.

Execution and portability endpoints

01

Compile

POST /v1/context/compile accepts a project ID and returns ranked approved values, redactions, purpose, capability, task commitment, project scope, and context commitment.

02

Invoke

POST /v1/models/invoke verifies the complete task, project, provider, and model binding before adapter or credential access.

03

MCP

POST /mcp supports the final 2025-11-25 protocol, tool discovery, scoped context compilation, pending memory proposals, checkpoints, and resources.

04

PowerHouse 0.4.0

POST /v1/export/pha and /v1/export/phm return verified PowerHouse artifacts. POST /v1/import/phm strictly verifies current and compatible historical capsules before import.

Conformance and memory quality

GET /.well-known/wclmfenx.json publishes exact protocol versions, endpoints, and implemented conformance requirements. The public suite defines Compatible, Verified, and Native as testable integration profiles.

Inspect the conformance suite →

Project diagnostics

GET /v1/memories/quality?project_id=… reports approved, pending, superseded, conflicting, and expired records for one project. The report itself has a deterministic commitment.

Project portfolio

The workspace stores independent durable projects and keeps broker memory policy, encryption keys, and synchronization configuration scoped to the selected project.