> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3iq.org/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 ` | Owner-scoped models and chat, public stats, retained settlement-policy metadata, plus B3IQ-native private jobs, receipts, and public settlement/payout read APIs |
| Local Host-Agent API | ` ./openapi/local-host-agent.openapi.yaml ` | Local health, OpenAI-compatible chat, models and model profiles, embeddings, image, audio, and rerank endpoints, receipts, and receipt submission |

## Generated API reference

HolyDocs reads both OpenAPI files and generates endpoint pages under
`/api/hosted-gateway` and `/api/local-host-agent`. They are listed under the
API Documentation tab 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.

## Related

**[API Overview](/developers/api-overview)**

Start with the high-level API map.
  **[Hosted Gateway](/developers/hosted-gateway)**

Use hosted OpenAI-compatible examples.
  **[Local API](/developers/local-api)**

Call local host-agent endpoints.