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

# Read model-tier readiness

> Proxies the model service readiness state. This route is intended for health checks and warmup visibility and does not require authentication.




## OpenAPI

````yaml /openapi/deepface.openapi.yaml get /readiness
openapi: 3.1.0
info:
  title: deepface.dev API
  version: v1
  summary: Managed API for face verification, embeddings, and vector comparison.
  description: >
    Canonical OpenAPI contract for the public deepface.dev gateway. This covers
    the public surface: health, capabilities, verify, represent, and compare.
  license:
    name: Proprietary
    url: https://deepface.dev/terms
servers:
  - url: https://api.deepface.dev
    description: Production gateway
security:
  - BearerAuth: []
  - ApiKeyHeader: []
tags:
  - name: Service
    description: Read-only service metadata and health routes.
  - name: Compute
    description: Authenticated face verification and vector-comparison endpoints.
paths:
  /readiness:
    get:
      tags:
        - Service
      summary: Read model-tier readiness
      description: >
        Proxies the model service readiness state. This route is intended for
        health checks and warmup visibility and does not require authentication.
      operationId: getReadiness
      responses:
        '200':
          description: Model server is warmed and ready to accept compute traffic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          description: Model server is still warming or temporarily unavailable
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ReadinessResponse'
                  - $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    ReadinessResponse:
      type: object
      required:
        - status
        - ready
        - warming
        - warmed_models
        - warmed_detectors
        - error
      properties:
        status:
          type: string
          enum:
            - ready
            - warming
            - error
        ready:
          type: boolean
        warming:
          type: boolean
        warmed_models:
          type: array
          items:
            type: string
        warmed_detectors:
          type: array
          items:
            type: string
        error:
          type: string
          description: >
            Empty when healthy or warming. When warmup fails, this is a symbolic
            error code such as runtime_warmup_failed; raw runtime exception text
            is not exposed on the public readiness route.
        warmed_at:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        detail:
          type: string
  responses:
    NotFound:
      description: Route does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Use your API key as a bearer token.
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative header for API key authentication.

````