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

# Readiness

> Readiness probe. Wire this to readinessProbe and to load balancers.

Sync endpoints run in the anyio threadpool, so a saturated pool means the
server cannot serve real traffic even though the event loop still turns.
This handler stays async on purpose: a sync handler would borrow a token of
the pool it is measuring, adding load exactly when there is none to spare,
and would queue rather than answer. Liveness lives at /health.

> [!NOTE]
>
> **No authentication required.**

> [!NOTE]
>
> Readiness probe. It fails when the API server cannot reach its dependencies,
> so a load balancer can stop routing traffic to this replica.
> Use [Healthcheck](https://docs.onyx.app/developers/api_reference/miscellaneous/healthcheck.md) for a liveness check.


## OpenAPI

````yaml GET /health/ready
openapi: 3.1.0
info:
  title: Onyx API
  description: Onyx API for AI-powered enterprise search and chat
  version: Development
servers:
  - url: https://cloud.onyx.app/api
security: []
paths:
  /health/ready:
    get:
      tags:
        - public
      summary: Readiness
      description: >-
        Readiness probe. Wire this to readinessProbe and to load balancers.


        Sync endpoints run in the anyio threadpool, so a saturated pool means
        the

        server cannot serve real traffic even though the event loop still turns.

        This handler stays async on purpose: a sync handler would borrow a token
        of

        the pool it is measuring, adding load exactly when there is none to
        spare,

        and would queue rather than answer. Liveness lives at /health.
      operationId: readiness
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}

````

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