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

# Readiness Check

> Readiness Check.

### Response

<ResponseField name="status" type="string">
  Readiness status
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "ready"
  }
  ```
</ResponseExample>

<ResponseExample>
  ```json 503 theme={null}
  {
    "status": "unready",
    "error": "database connection failed"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /ready
openapi: 3.0.1
info:
  title: Agni API
  version: 1.0.0
  description: >-
    Agni API for managing agents, tools, widget settings, telephony, and
    integrations.
servers:
  - url: https://api.ravan.ai
security:
  - X-Api-Key: []
tags:
  - name: AgentService
  - name: AgentToolService
  - name: WidgetSettingsService
  - name: PhoneService
  - name: AppointmentService
  - name: GHLService
  - name: CalComService
  - name: CampaignService
  - name: ContactService
  - name: CallingService
  - name: RAGService
  - name: ModelService
  - name: HealthService
paths:
  /ready:
    get:
      tags:
        - HealthService
      summary: Readiness Check
      operationId: ReadinessCheck
      responses:
        '200':
          description: Service is ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
        '503':
          description: Service is not ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnreadyResponse'
      security: []
components:
  schemas:
    ReadyResponse:
      type: object
      properties:
        status:
          type: string
          description: Readiness status
          example: ready
    UnreadyResponse:
      type: object
      properties:
        status:
          type: string
          description: Readiness status
          example: unready
        error:
          type: string
          description: Reason for unreadiness
          example: database connection failed
  securitySchemes:
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key

````