API Reference

The VEX API documentation is generated using Rustdoc.

Crate Documentation

CrateDescriptionLink
vex-coreCore types: Agent, Genome, MerkleTree, ContextPacketView Docs
vex-adversarialRed/Blue verification, Consensus, DebateView Docs
vex-temporalEpisodic memory, TimeHorizon, DecayView Docs
vex-llmLLM providers, RateLimiter, MetricsView Docs
vex-apiHTTP server, JWT auth, CircuitBreakerView Docs
vex-persistStorage backends, Audit logsView Docs
vex-queueJob queue, Worker poolView Docs
vex-runtimeAgent orchestration, ExecutionView Docs

Quick Reference

Creating an Agent

use vex_core::{Agent, AgentConfig};

let agent = Agent::new(AgentConfig {
    name: "MyAgent".to_string(),
    role: "You are helpful".to_string(),
    max_depth: 3,
    spawn_shadow: true,
});

Using an LLM Provider

use vex_llm::{DeepSeekProvider, LlmProvider};

let llm = DeepSeekProvider::new(api_key);
let response = llm.ask("Hello!").await?;

Adversarial Verification

use vex_adversarial::{ShadowAgent, ShadowConfig};

let shadow = ShadowAgent::new(&agent, ShadowConfig::default());
let issues = shadow.detect_issues("This always works!");

Episodic Memory

use vex_temporal::{EpisodicMemory, HorizonConfig};

let mut memory = EpisodicMemory::new(HorizonConfig::default());
memory.remember("Important fact", 0.9);

Building Docs Locally

cd vex
cargo doc --workspace --no-deps --open