LuxoAILuxoAIdocs
Welcome
InvoiceAgentInternalSupplyAgentBetaLearnAgentBeta
OverviewAgent Corev0.11.0StableObservabilityv0.6.0StableLuxo Assistantv0.6.0BetaFeedback UIv0.2.0BetaLuxo MLScaffold
API Console
All systemsv0.8.1
LuxoAILuxoAIdocs
WelcomeApi

API Reference

Every export, every signature.

Production-grade reference for the public surface of every Luxo package. Each entry has the TypeScript signature, parameters, return types, and a copy-pasteable example — the same level an LLM agent or a senior engineer needs to write production code without reading source.

At a glance
Packages covered
4 TypeScript packages
Source
luxo-agent-kit/packages/*
Modules
agent-core · /llm · /feedback · /adapters/* · observability · /next · /node · luxo-assistant · /server · feedback-ui
Coverage
Every exported function, class, hook, component, and type

Packages

Pick the package you’re calling. Each reference page is grouped by module path so the import shape matches the in-source layout.

@luxoai-dev/agent-core

Agent Core

Action registry, agent runtime, LLM gateway, judge, audit sinks, feedback validation, provider adapters.

Open reference

@luxoai-dev/observability

Observability

Health, readiness, Prometheus metrics, structured logger, LLM telemetry, feedback recording, Next + Node helpers.

Open reference

@luxoai-dev/luxo-assistant

Luxo Assistant

Server route factory, env-aware completion, client surface (LuxoRoot, hooks), manifest contract, directive parsing.

Open reference

@luxoai-dev/feedback-ui

Feedback UI

FeedbackWidget component and the useFeedback hook that submits validated 1-5 ratings.

Open reference

Conventions

Every API reference page follows the same shape:

  • Module headers — sections are grouped by import path so @luxoai-dev/agent-core/llm always reads as a single neighborhood.
  • Signature card — kind chip (Function · Class · Hook · Component), full TypeScript signature, prose description, parameter table with types and Required column, return shape, and a runnable example.
  • Type cards — interface / type / enum definitions with field tables and at least one usage example per non-trivial type.
  • Status badges — Stable entries are version-pinned and breaking changes ship a new major; Beta may still shift; Internal entries are exported but not part of the public stability contract.