API documentation · Arkham 1.0

Dynamic yield pricing fundamentals

Arkham 1.0 exposes a real-time pricing API for equipment rental yield management. Quotes are signed with a short TTL (~90s); fleet state (available / reserved / in-use) stays consistent for partners and customers. Browser clients call the Zi Humana same-origin proxy at /api/arkham/*.

Overview

Use Arkham when you need demand-responsive rental rates, multi-machine quotes, location-aware delivery, and auditable booking tracking — aligned with the program process (quote → clearing price → lease → billing).

  • Demo fleet with dedicated machine IDs (e.g. EQ-001 …)
  • Multi-select machines, sites, and timing with country/currency support
  • Live status board for customers, partners, and internal ops
  • Three pricing engines — RL elasticity, SDP leases, spot auction — behind each quote

Concepts

ConceptDescription
QuoteTime-limited price offer (~90s). Selected machines become reserved.
BookingConfirmed reservation. Machines move to in_use.
UtilizationShare of fleet reserved or in use; drives surge pricing.
LocationDelivery / job site with country, city, county, and postal pin fields.

Same-origin proxy

Browser clients should call the Zi Humana proxy at /api/arkham/*. The route forwards to the Arkham backend configured via ARKHAM_BACKEND_URL (default demo host). Demo is open — no API key required; optional x-api-key is forwarded when present.

GET  /api/arkham/health
GET  /api/arkham/fleet/machines
POST /api/arkham/pricing/quote
Content-Type: application/json
Accept: application/json

Get a price quote

POST /api/arkham/pricing/quote

curl -X POST https://your-site/api/arkham/pricing/quote \
  -H 'Content-Type: application/json' \
  -d '{
    "machine_ids": ["EQ-001", "EQ-006"],
    "country": "IE",
    "city": "Dublin",
    "county": "Dublin",
    "pin_eircode": "D02 AF30",
    "start_time": "2026-08-10T14:00:00Z",
    "duration_hours": 8
  }'

Confirm a booking

POST /api/arkham/booking/confirm

curl -X POST https://your-site/api/arkham/booking/confirm \
  -H 'Content-Type: application/json' \
  -d '{ "quote_id": "<uuid>", "customer_name": "Site Supervisor" }'

Track delivery

GET /api/arkham/booking/{booking_id}/track returns status, coordinates, and ETA. Complete with POST /api/arkham/booking/{booking_id}/complete to return machines to available.

Fleet & availability

  • GET /api/arkham/fleet/machines — catalog + status
  • GET /api/arkham/fleet/locations — countries with currency and pin labels
  • GET /api/arkham/fleet/summary — counts / utilization
  • GET /api/arkham/bookings — partner booking list
  • POST /api/arkham/fleet/machines/{id}/release — ops release for non-available units

API endpoints

MethodPath (via proxy)Purpose
GET/api/arkham/healthLiveness + fleet summary
GET/api/arkham/fleet/machinesList equipment
GET/api/arkham/fleet/locationsList countries / sites
GET/api/arkham/fleet/summaryUtilization
POST/api/arkham/pricing/quoteMulti-machine quote
POST/api/arkham/booking/confirmConfirm → in_use
GET/api/arkham/booking/{id}/trackTracking
POST/api/arkham/booking/{id}/completeRelease fleet
GET/api/arkham/bookingsPartner ledger
POST/api/arkham/fleet/machines/{id}/releaseOps machine release

Errors

CodeWhen
400Invalid location or empty machine list
409Machine not available / already reserved
404Quote or booking not found
410Quote expired
502Arkham backend unreachable — check ARKHAM_BACKEND_URL

Program & business process

Quote requests flow through RL elasticity, SDP lease pricing, and spot auction engines to a market-clearing price, then through booking confirmation, tracking, and revenue audit.

Arkham program process diagram
Program flow. Search → quote → pricing engines → market-clearing price → lease → billing ledger.
Arkham business process diagram
Business flow. Customer segments, platform modules, strategic partners, and revenue streams.