Orenyx Engine

One API for everything behind your account: automating work, tracking billing, and notifying you (or your systems) when something happens.

What this API does

Three things, in plain terms:

  • Runs your workflows. When something triggers a workflow (a webhook, a schedule, an event), it gets picked up and worked through automatically.
  • Tracks money. Every charge, refund, and payment is recorded in a running ledger, and checked against what your payment processor actually collected.
  • Tells your systems what happened, through webhooks, so you don't have to keep checking the dashboard yourself.

Architecture at a glance

Three layers, each with one job. You never call the bottom layer directly, everything goes through the API.

Your app / browser
       │
       │  x-api-key
       ▼
┌──────────────────┐
│   Control API    │   Auth, billing, ledger, settlement, workflows, webhooks
└──────────────────┘
       │
       │  enqueues jobs
       ▼
┌──────────────────┐
│  Job Queues       │   One queue per job type: bot-intake, bot-dispatch,
│  (BullMQ + Redis) │   bot-support, bot-payment, bot-outreach, bot-followup,
└──────────────────┘   bot-scheduling, workflow-execution, dead-letter
       │
       │  picked up by
       ▼
┌──────────────────┐
│  Bot Workers      │   Each queue has its own worker process. A failed job
└──────────────────┘   retries automatically before landing in dead-letter.
       │
       ▼
┌──────────────────┐
│  Database          │   One record of truth for every tenant, kept
│  (PostgreSQL)      │   completely separate between accounts.
└──────────────────┘

Two takeaways: (1) every job type has its own isolated queue, so a slow or failing bot never blocks a different one, and (2) a job that keeps failing after several retries is never silently lost, it lands in the dead-letter queue for inspection rather than disappearing.

Quickstart

1. Sign in and issue an API key from API Keys. Copy it right away, since it's shown once and never again.

2. Confirm you can reach the API:

curl https://portal.orenyxengine.com/api/health

3. Call something real, with your key in the header:

curl https://portal.orenyxengine.com/api/ledger/balance \
  -H "x-api-key: orx_live_..."

Authentication

Every request needs one thing: your API key, in an x-api-key header.

  • You can restrict a key to specific areas (ledger, billing, webhooks, etc.) when you create it, or leave it unrestricted.
  • A key that tries to call something outside what it's allowed to do gets rejected.
Create, restrict, or revoke keys from the API Keys page. See Developer Guides for ready-to-use SDK/CLI examples instead of raw HTTP calls.

Keeping track of usage

Usage & Ledger shows your current balance, transaction history, an estimate of your next invoice, and any usage alerts you've set up.

Was this page helpful?