OpenAPI
B3IQ hosted gateway and local host-agent OpenAPI specs.
B3IQ keeps hand-authored endpoint contracts for its supported HTTP surface. These specs are not SDKs, adapters, or client libraries.
Specs
| Spec | File | Covers |
|---|---|---|
| Hosted Gateway API | ./openapi/hosted-gateway.openapi.yaml | Hosted OpenAI-compatible /v1/models and /v1/chat/completions, plus B3IQ-native private jobs, receipts, billing, public, operator, and admin APIs |
| Local Host-Agent API | ./openapi/local-host-agent.openapi.yaml | Local health, OpenAI-compatible chat/models, model profiles, receipts, and receipt submission |
Generated API Reference
HolyDocs reads the hosted gateway OpenAPI file and generates endpoint pages
under /api-reference. The generated pages are also listed in the sidebar by
tag, method, and endpoint summary.
Use the hand-written developer guides first when you need context, safe key handling, or product-level explanation. Use generated reference pages when you need exact request/response schemas.
Contract Scope
Endpoint contracts only
The OpenAPI specs describe HTTP contracts. They do not promise maintained SDKs, product adapters, or generated clients.