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

# API overview

> Shared conventions for the BreadBowl Embed alpha REST API

BreadBowl Embed uses JSON over HTTPS. All API requests use this base URL:

```text theme={null}
https://embed.breadbowl.ai
```

Every `/v1/*` request requires your server-side API key:

```http theme={null}
Authorization: Bearer qkv_live_...
Content-Type: application/json
```

`GET /healthz` and `GET /readyz` do not require authentication.

Every response includes `x-request-id`. Record it for troubleshooting. Do not log API keys, query text, document text, or complete request bodies.

Timestamps use ISO 8601 UTC. Usage token totals are decimal strings. Scores order results within a response and do not have a fixed global range.

The API is versioned under `/v1`. Clients should ignore unknown response fields. Partner-impacting changes will be recorded in the [changelog](/changelog).