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

# Check inference readiness.

> Returns a ready status when the API and an inference worker can accept requests. A `503` response means the service is temporarily unavailable or the worker is not ready.



## OpenAPI

````yaml /openapi.json get /health/ready
openapi: 3.1.0
info:
  title: Aspas Labs API
  version: 1.0.0
  description: >-
    A small, direct API for structured decisions with Goldenfish. The free
    decision and model discovery surface does not require an API key. Send
    context, an instruction, and either inline choices or a reusable catalog.
    The response returns one selected choice, confidence, probabilities, the
    model used, and input-token usage. The model is selected in the request body
    so the public contract stays stable as the model catalog grows. Catalog
    management is a separate protected surface and requires a bearer key.
  contact:
    name: Aspas Labs
    url: https://aspaslabs.com/
    email: hello@aspaslabs.com
  license:
    name: Aspas Labs API terms
    url: https://aspaslabs.com/
servers:
  - url: https://api.aspaslabs.com
    description: Production
security: []
tags:
  - name: Decisions
    description: >-
      Run a constrained inference request and receive a typed choice with
      confidence and per-choice probabilities.
  - name: Models
    description: >-
      Discover model identifiers, availability status, and public input and
      choice limits.
  - name: Catalogs
    description: Create and manage named choice catalogs for repeatable decision workflows.
  - name: Health
    description: >-
      Check process liveness and whether an inference worker is ready to serve
      requests.
paths:
  /health/ready:
    get:
      tags:
        - Health
      summary: Check inference readiness.
      description: >-
        Returns a ready status when the API and an inference worker can accept
        requests. A `503` response means the service is temporarily unavailable
        or the worker is not ready.
      operationId: readyHealth
      responses:
        '200':
          description: The API and an inference worker are ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiveHealth'
        '503':
          $ref: '#/components/responses/Unavailable'
components:
  schemas:
    LiveHealth:
      type: object
      description: >-
        The minimal health response returned by the liveness and readiness
        endpoints.
      required:
        - status
      properties:
        status:
          type: string
          description: The current health status, such as `live` or `ready`.
          example: live
    ErrorResponse:
      type: object
      description: The common error envelope returned for failed requests.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
              description: >-
                A human-readable explanation intended for logs and operator
                feedback.
              example: Rate limit exceeded.
            type:
              type: string
              description: The broad error category for program logic.
              enum:
                - invalid_request_error
                - authentication_error
                - rate_limit_error
                - model_error
                - server_error
            code:
              type: string
              description: A machine-readable reason for the failure.
              example: rate_limit_exceeded
            param:
              type:
                - string
                - 'null'
              description: The request parameter associated with the error, or `null`.
              example: null
  responses:
    Unavailable:
      description: >-
        The service or model is temporarily unavailable. Retry safely with
        bounded backoff when the operation can be repeated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.