Flux Skill

Flux is a persistent, shared, event-sourced world state engine. Agents publish immutable events, and Flux derives canonical state that all agents can observe.

Key Concepts

• - Events: Immutable observations (temperature readings, status changes, etc.)
• Entities: State objects derived from events (sensors, devices, agents)
• Properties: Key-value attributes of entities (merged on update — only changed properties need to be sent)
• Streams: Logical event namespaces (sensors, agents, system)
• Namespaces: Multi-tenant isolation with token auth (optional, for public instances)

Prerequisites

Public instance: https://api.flux-universe.com (namespace purchased at flux-universe.com — name auto-assigned at purchase, e.g. dawn-coral)
Local instance: http://localhost:3000 (default, override with FLUX_URL env var)

Authentication: Set FLUX_TOKEN to your bearer token. Required for the public instance. Optional for local instances with auth disabled.

Namespace Prefix

All entity IDs must be prefixed with your namespace:
INLINECODE5

Example with namespace dawn-coral:
CODEBLOCK0

Entity IDs without a namespace prefix will be rejected on auth-enabled instances.

Getting Started

First, verify your connection:
CODEBLOCK1

Then check the directory to see what's available on the Flux Universe:
CODEBLOCK2

The directory lists all active namespaces, entity counts, and total entities — a good way to discover what data is flowing through the system.

Scripts

Use the provided bash script in the scripts/ directory:

• - flux.sh - Main CLI tool

Common Operations

Publish Event

Query Entity State

List All Entities

Delete Entity

Batch Publish Events

Check Connector Status

Admin Config

Use Cases

Multi-Agent Coordination

Status Tracking

API Endpoints

Event Ingestion:

• - POST /api/events — Publish single event (1 MB limit)
• INLINECODE10 — Publish multiple events (10 MB limit)

State Query:

• - GET /api/state/entities — List all entities (supports ?prefix= and ?namespace= filters)
• INLINECODE14 — Get specific entity

Entity Management:

• - DELETE /api/state/entities/:id — Delete single entity
• INLINECODE16 — Batch delete (by namespace/prefix/IDs)

Real-time Updates:

• - GET /api/ws — WebSocket subscription

Connectors:

• - GET /api/connectors — List connectors and status
• INLINECODE19 — Store PAT credential
• INLINECODE20 — Remove credential

Admin:

• - GET /api/admin/config — Read runtime config
• INLINECODE22 — Update runtime config (requires FLUXADMINTOKEN)

Namespaces (auth mode only):

• - POST /api/namespaces — Register namespace (returns auth token)

Notes

• - Events auto-generate UUIDs (no need to provide eventId)
• Properties merge on updates — only send changed properties, existing ones are preserved
• Timestamp field must be epoch milliseconds (i64) — required by the API, auto-generated by flux.sh
• State persists in Flux (survives restarts via NATS JetStream + snapshots)
• Entity IDs support / for namespacing (e.g., scada/pump-01)