Documentation
Public API and product reference
Use the public reference for runtime, reality, gateway, delivery, and node setup. Internal admin controls are excluded.
Primary surfaces
Runtime, reality, gateway
Organized around the surfaces teams actually integrate.
Auth patterns
Bearer and buyer key
Public routes accept buyer JWTs or scoped API keys.
Delivery options
Dashboard, webhook, bucket
Completed jobs can stay in the workspace or push into buyer systems.
Operator setup
Windows, macOS, Linux
Signed installers and runtime requirements stay public.
Runtime endpoints
Health, readiness, config, and storage status expose the current hub posture.
/v1/models
/v1/chat/completions
/v1/embeddings
/v1/images/generations
/v1/audio/transcriptions
Authentication
Buyer access supports bearer tokens and API keys, depending on the route.
Authorization: Bearer <jwt> X-API-Key: <buyer-key>
Reality processing
Use these endpoints to model sites, create epochs, ingest capture sets, and move them into a ready state.
Gateway
The gateway exposes an OpenAI-compatible model surface. Reality routes stay separate when delivery and evidence matter.
Delivery and callbacks
Deliver completed stages into the workspace, a buyer webhook, or buyer HTTPS object storage.
X-Ryvion-Signature: <ed25519-signature> X-Ryvion-Event: job.completed X-Ryvion-Timestamp: 1710000000
Node setup
Operators can launch Ryvion Node directly from the public control plane. The hub serves signed platform binaries, and the service layer is installed automatically for Windows, macOS, and Linux.
Windows
PowerShell as Administrator. Docker Desktop installed and running for container workloads.
Install command
iex ((New-Object System.Net.WebClient).DownloadString('https://ryvion-hub.fly.dev/install.ps1'))- Installs signed binary, writes config to %USERPROFILE%\.ryvion, registers RyvionNode service.
- Service exposes local API on http://127.0.0.1:45890 for the desktop app.
- GPU workloads require Docker Desktop and vendor drivers.
macOS
Terminal on macOS 13+. Docker Desktop for container workloads. Apple Silicon auto-selects arm64.
Install command
curl -sSL 'https://ryvion-hub.fly.dev/install.sh?platform=macos' | bash
- Binary in /usr/local/bin, launch agent at ~/Library/LaunchAgents/com.ryvion.node.plist.
- Launch agent exposes local API on http://127.0.0.1:45890 for the desktop app.
- Without containers the node can still run, but eligibility is narrower.
Linux
Regular user on Ubuntu or systemd-based distro. Docker Engine installed and reachable.
Install command
curl -sSL https://ryvion-hub.fly.dev/install.sh | bash
- Signed binary to ~/.ryvion, systemd service named ryvion-node.
- Systemd service exposes local API on http://127.0.0.1:45890 for the desktop app.
- On GPU hosts, install vendor drivers first for Docker accelerator access.
Runtime variables
Most operators only need the default hub URL. Set a bind token when onboarding through an operator invite flow, and set a declared country when you want the node considered for country-restricted policy paths.
RYV_HUB_URL=https://ryvion-hub.fly.dev RYV_UI_PORT=45890 RYV_BIND_TOKEN=<optional-operator-bind-token> RYV_DECLARED_COUNTRY=CA RYV_LOG_LEVEL=info RYV_WORK_DIR=<optional-work-directory override>
Operator checks
Service is running and node appears in dashboard after first heartbeat.
Local API responds on http://127.0.0.1:45890/healthz before opening the desktop app.
Docker Desktop or Engine running on hosts for container workloads.
Set RYV_DECLARED_COUNTRY for certified country-restricted routing.
Product shell
The authenticated workspace is for buyer operations: site state, capture visibility, API keys, and environment controls.