Developer Guides & SDKs

Official SDKs, CLI tools, cURL examples, sandbox testing credentials, and sample datasets for integrating with Orenyx AI.

1. Test-Environment API Keys

Issuing a key as Test rather than Live tags it separately in your request logs and dashboard, so you can tell test traffic apart from production traffic at a glance.

EnvironmentAPI Base URLAPI Key PrefixWhat actually differs
Testhttps://portal.orenyxengine.com/apiorx_test_...Tagged separately in the dashboard and request log. Plan-change proration (the one billing-affecting write reachable via API key) is recorded at $0 instead of a real charge.
Livehttps://portal.orenyxengine.com/apiorx_live_...Production traffic. Proration and every other action is real.
Issuing Test Keys: Go to Developer → API Keys in your portal dashboard and select "Test" in the environment dropdown to issue a key starting with orx_test_.

2. Sample Test Data Package

To test qualification pipelines and analytics dashboards, you can seed sample test leads and workflow runs into your sandbox workspace using our CLI seeder:

# Seed 50 realistic sample leads into your sandbox tenant
npx ts-node scripts/seed-leads.ts --mode=bulk --count=50

# Trigger a live test lead webhook execution against your local sandbox API
npx ts-node scripts/seed-leads.ts --mode=live --count=5 --api=http://localhost:41760/api/v1

Sample Test Lead Payload (JSON)

{
  "name": "Sarah Jenkins",
  "email": "sarah.jenkins@acme-corp.com",
  "company": "Acme Corporation",
  "title": "VP of Growth & Revenue",
  "message": "We need an AI lead qualification engine for our 50-person B2B sales team. Budget is $80k/yr.",
  "teamSize": "50-100",
  "metadata": {
    "source": "demo_request_form",
    "utm_campaign": "q3_enterprise_ai"
  }
}

3. Node.js / TypeScript SDK (`orenyx-sdk`)

Install the Node.js SDK from npm:

npm install orenyx-sdk

Usage Example

import { OrenyxClient } from 'orenyx-sdk';

const client = new OrenyxClient({
  baseUrl: 'https://portal.orenyxengine.com/api',
  apiKey: process.env.ORENYX_API_KEY!, // orx_test_... or orx_live_...
});

// Fetch active ledger balance
const balance = await client.getLedgerBalance();

// List recent audit logs & executions
const entries = await client.getLedgerEntries(50);

4. Python SDK (`orenyx-sdk`)

Install the Python SDK via pip:

pip install -e packages/sdk-python

Usage Example

from orenyx_sdk import OrenyxClient

client = OrenyxClient(
    base_url="https://portal.orenyxengine.com/api",
    api_key="orx_test_sec_99182"
)

# Check system balance and test connection
balance = client.get_ledger_balance()
print(f"Active balance: {balance}")

# Issue scoped test key
new_key = client.issue_api_key("CI Test Key", scopes=["ledger", "webhooks"])

5. Command Line Interface (CLI)

export ORENYX_API_URL="https://portal.orenyxengine.com/api"
export ORENYX_API_KEY="orx_test_..."

orenyx health
orenyx ledger:balance
orenyx keys:issue "CI key" --scopes=ledger,webhooks
orenyx webhooks:subscribe https://example.com/hook --events=lead.created

6. Plain cURL Example

curl https://portal.orenyxengine.com/api/ledger/entries \
  -H "x-api-key: orx_test_..." \
  -H "accept: application/json"

Was this page helpful?