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

# Get process readiness

> Returns whether the gateway is ready to receive traffic.



## OpenAPI

````yaml /openapi.json get /readyz
openapi: 3.1.0
info:
  description: The public API for Perflo financial agents.
  license:
    identifier: LicenseRef-Perflo-Proprietary
    name: Proprietary
  title: Perflo Financial Agents API
  version: 1.0.0
servers:
  - url: https://api.perflo.ai
security: []
tags:
  - description: Gateway health and public API metadata endpoints.
    name: system
paths:
  /readyz:
    get:
      tags:
        - system
      summary: Get process readiness
      description: Returns whether the gateway is ready to receive traffic.
      operationId: getReadiness
      parameters:
        - $ref: '#/components/parameters/PerfloRequestId'
      responses:
        '200':
          description: The process is ready.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/PerfloRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
        '422':
          description: The request shape is invalid.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/PerfloRequestId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: The response contract failed.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/PerfloRequestId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: A required dependency is not ready.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/PerfloRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
      security: []
components:
  parameters:
    PerfloRequestId:
      description: >-
        Optional caller request identifier. Unsafe values are replaced with a
        generated UUID.
      in: header
      name: X-Request-Id
      required: false
      schema:
        pattern: ^[A-Za-z0-9._~-]{8,128}$
        type: string
  headers:
    PerfloRequestId:
      description: Request identifier echoed on every API response.
      schema:
        pattern: ^[A-Za-z0-9._~-]{8,128}$
        type: string
  schemas:
    ReadinessResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - ready
            - not_ready
          description: Dependency readiness status.
      required:
        - status
      additionalProperties: false
      description: Application readiness response.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: Stable URL identifying the problem class.
        title:
          type: string
          minLength: 1
          description: Short human-readable problem title.
        status:
          type: integer
          minimum: 400
          maximum: 599
          description: HTTP status code for this occurrence.
        detail:
          type: string
          minLength: 1
          description: Human-readable occurrence detail.
        instance:
          type: string
          pattern: ^\/.*
          description: Request path identifying this problem occurrence.
        code:
          type: string
          pattern: ^[a-z][a-z0-9_]*$
          description: Stable machine-readable Perflo error code.
        fields:
          anyOf:
            - type: array
              items:
                $ref: '#/components/schemas/ProblemField'
            - type: 'null'
          description: >-
            Field-level failures, or null when the problem is not
            field-specific.
        request_id:
          type: string
          pattern: ^[A-Za-z0-9._~-]{8,128}$
          description: Request identifier used to correlate API responses with server logs.
        retryable:
          type: boolean
          description: Whether repeating the identical request can safely succeed.
        submission_uncertain:
          type: boolean
          description: >-
            Whether an upstream write may have landed and must not be
            resubmitted.
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - fields
        - request_id
        - retryable
        - submission_uncertain
      additionalProperties: false
      description: >-
        RFC 9457 problem details with stable Perflo correlation and retry
        semantics.
    ProblemField:
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Human-readable validation failure.
        path:
          type: string
          minLength: 1
          description: Dot-delimited path to the invalid field.
      required:
        - message
        - path
      additionalProperties: false
      description: One field-level request validation failure.

````