> ## 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.

# Check readiness

> 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.




## OpenAPI

````yaml /openapi/openapi.yaml get /readyz
openapi: 3.1.0
info:
  title: BreadBowl Embed API (Alpha)
  version: 0.1.0-alpha
  description: >
    REST API for managed multi-vector retrieval and transient document scoring.


    BreadBowl Embed accepts source text and returns ranked document and chunk
    references. It does not return conventional embedding vectors.
servers:
  - url: https://embed.breadbowl.ai
    description: Production API
security:
  - bearerAuth: []
tags:
  - name: Service health
    description: Unauthenticated liveness and readiness checks
  - name: Indexes
    description: Create and discover tenant-scoped indexes
  - name: Documents
    description: Upsert and delete indexed documents
  - name: Retrieval
    description: Search an index or score a transient candidate set
  - name: Usage
    description: Inspect current UTC-month usage and assigned limits
paths:
  /readyz:
    get:
      tags:
        - Service health
      summary: Check readiness
      description: >
        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.
      operationId: getReadiness
      responses:
        '200':
          description: Service is ready
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
              example:
                ok: true
                model: breadbowl-embed-alpha
                model_version: version-2026-07
        '503':
          description: API is reachable but a required serving capability is unavailable
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotReadyResponse'
              example:
                ok: false
      security: []
components:
  headers:
    RequestId:
      description: Correlation ID for logging and support. This is not a credential.
      schema:
        type: string
        minLength: 1
  schemas:
    ReadyResponse:
      type: object
      additionalProperties: false
      required:
        - ok
        - model
        - model_version
      properties:
        ok:
          type: boolean
          const: true
        model:
          type: string
          minLength: 1
        model_version:
          type: string
          minLength: 1
    NotReadyResponse:
      type: object
      additionalProperties: false
      required:
        - ok
      properties:
        ok:
          type: boolean
          const: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: BreadBowl Embed API key
      description: Tenant-scoped API key beginning with `qkv_live_`.

````