Skip to main content

Changelog

Bairav's HTTP paths are not versioned. Compare the downloadable specs (gateway, ingest, portal) between releases, and use this page to see what changed.

Each release of this site records the Bairav source it was generated from in the x-source block of every spec (info.x-source).

Initial publication​

First published API reference, generated from the Bairav source at commit 870b92fe954c.

Published

  • Gateway API: 7 operations described by hand. Chat completions, provider passthrough, reasoning-trail ingest and read, database activity, health.
  • Ingest API: 6 operations described by hand. Sensor events, the governance channel, security events, OpenTelemetry traces, SBOM upload, health.
  • Portal API: 223 operations, generated and filtered by an allowlist. Request bodies are described. Responses are described for sign-in, session refresh, identity, gateway keys and the Audit ledger; the rest are open.

Behaviour you can rely on

  • Ingest rate limits fail closed: 503 with Retry-After if the limiter is down.
  • Ingest is idempotent for sensor events, security events, OpenTelemetry spans and SBOMs.
  • Gateway refusals are normal completions with HTTP 200 and X-Bairav-Blocked: 1.
  • The Audit ledger exposes GET /api/ledger/head and expected_head verification to detect truncation.

Known gaps

  • Many Portal API responses are not yet typed in the source, so their schemas are open.
  • The gateway has no gateway-side rate limit.
  • The Portal API has no long-lived API key; automation uses a local account session. See Authentication.