API reference

Sandbox Gateway

Sandbox-ready metered developer gateway. Real Arbebus transport/AI backends are not connected.

GET /api/v1/health

Confirms the developer gateway function is reachable. No authentication. Does not consume customer technical quota.

{
  "ok": true,
  "service": "arbebus-developer-gateway",
  "status": "available",
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

POST /api/v1/sandbox/ping

Proves a portal-created API key authenticates a real gateway request. Does not call AI, routing, or transit services.

Required headers:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Optional:

Idempotency-Key: opaque-client-value

Body: empty JSON object or optional clientRequestId string.

{
  "ok": true,
  "mode": "sandbox",
  "message": "Arbebus Developer Gateway is ready.",
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

On successful idempotency replay, the response includes X-Arbebus-Idempotency-Replayed: true and a new outer requestId.

Required scope

sandbox:invoke

Response headers

  • X-Arbebus-Request-Id
  • X-RateLimit-Limit / Remaining / Reset (authenticated)
  • X-Arbebus-Quota-Limit / Remaining / Reset / Metric (authenticated when quota enforced)
  • X-Arbebus-Idempotency-Replayed (replay only)

Usage accounting

  • First successful execution consumes 1 request unit and records latency.
  • Successful idempotency replay records an idempotency_replay event with 0 request units.
  • Quota and rate-limit rejections record zero consumed units.
  • Token fields remain null until real AI integration.

CORS

Exact origins only: https://developer.arbebus.com, http://localhost:8888. Methods: GET, POST, OPTIONS. Request headers: Authorization, Content-Type, Idempotency-Key.