# BreadBowl Embed (Alpha)

> BreadBowl Embed alpha documentation

## Docs

- [Delete a document](https://docs.breadbowl.ai/api-reference/documents/delete-a-document.md): Removes a document from an index by its customer-provided ID. Deletion is idempotent; deleting an absent ID succeeds with `deleted: false`.
- [Upsert documents](https://docs.breadbowl.ai/api-reference/documents/upsert-documents.md): Creates or replaces one to 50 documents in an index. `doc_id` is the idempotency identity within the index.
- [Create an index](https://docs.breadbowl.ai/api-reference/indexes/create-an-index.md): Creates a tenant-scoped index. Names are unique within a tenant. The returned model version is immutable for that index; create and reingest into a new index when moving to another version.
- [List indexes](https://docs.breadbowl.ai/api-reference/indexes/list-indexes.md): Lists all indexes visible to the authenticated tenant.
- [API overview](https://docs.breadbowl.ai/api-reference/overview.md): Shared conventions for the BreadBowl Embed alpha REST API
- [Score transient documents](https://docs.breadbowl.ai/api-reference/retrieval/score-transient-documents.md): Ranks one to 50 request-local documents for one query without adding them to an index. An aggregate usage event is recorded, but the submitted query, documents, chunks, and derived representations are not persisted as indexed content.
- [Search an index](https://docs.breadbowl.ai/api-reference/retrieval/search-an-index.md): Returns relevance-ranked chunk references from one index. Original source text is not included; hydrate documents from your own datastore using `doc_id`.
- [Check liveness](https://docs.breadbowl.ai/api-reference/service-health/check-liveness.md): Confirms that the API process is reachable. A successful liveness check does not guarantee that the service is ready to process model requests; use `/readyz` for readiness.
- [Check readiness](https://docs.breadbowl.ai/api-reference/service-health/check-readiness.md): Returns HTTP 200 only when the service is ready to process requests. Model identity in the successful response is informational and identifies the currently configured serving version.
- [Get usage and limits](https://docs.breadbowl.ai/api-reference/usage/get-usage-and-limits.md): Returns aggregate usage for the current UTC calendar month, the limits assigned to the tenant, and current remaining token and document allowances. Token values are decimal strings to prevent integer precision loss.
- [Changelog](https://docs.breadbowl.ai/changelog.md): Customer-visible changes to the BreadBowl Embed alpha API
- [Add documents](https://docs.breadbowl.ai/guides/ingest-documents.md): Add, replace, and delete searchable documents
- [Search](https://docs.breadbowl.ai/guides/search.md): Search an index and use the ranked results
- [Rank without an index](https://docs.breadbowl.ai/guides/transient-scoring.md): Rank a small set of documents for one request
- [BreadBowl Embed (Alpha)](https://docs.breadbowl.ai/index.md): Add your text and get ranked references back
- [Quickstart](https://docs.breadbowl.ai/quickstart.md): Run your first search in about five minutes
- [Errors and retries](https://docs.breadbowl.ai/reliability/errors-and-retries.md): Handle API failures without duplicating work
- [Limits and usage](https://docs.breadbowl.ai/reliability/limits-and-usage.md): Alpha request limits and current usage
- [Data and API key safety](https://docs.breadbowl.ai/security/data-handling.md): What you can send and how to protect access
- [Support](https://docs.breadbowl.ai/support.md): Get help with the BreadBowl Embed alpha

## OpenAPI Specs

- [openapi](https://docs.breadbowl.ai/openapi/openapi.yaml)