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

# Health check

> Reports runtime mode, queue statistics, and migration status.



## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: FamilyCo API
  description: Core and Knowledge endpoints from the FamilyCo Fastify server.
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: http://127.0.0.1:4000
    description: Local development server
security:
  - bearerAuth: []
tags:
  - name: Core
    description: Infrastructure and runtime status endpoints.
  - name: Auth
    description: Token and API key related endpoints.
  - name: Knowledge
    description: Document upload, indexing, and retrieval endpoints.
paths:
  /health:
    get:
      tags:
        - Core
      summary: Get service health
      description: Reports runtime mode, queue statistics, and migration status.
      responses:
        '200':
          description: Service health snapshot
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - mode
        - queueDriver
        - queue
        - migration
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
        mode:
          type: string
          enum:
            - normal
            - read_only
        queueDriver:
          type: string
          enum:
            - memory
        queue:
          $ref: '#/components/schemas/HealthQueueStats'
        migration:
          oneOf:
            - $ref: '#/components/schemas/MigrationState'
            - type: 'null'
    HealthQueueStats:
      type: object
      required:
        - agentRunConcurrency
        - toolExecuteConcurrency
        - totalJobs
        - queuedJobs
        - runningJobs
        - completedJobs
        - failedJobs
        - byType
      properties:
        agentRunConcurrency:
          type: integer
        toolExecuteConcurrency:
          type: integer
        totalJobs:
          type: integer
        queuedJobs:
          type: integer
        runningJobs:
          type: integer
        completedJobs:
          type: integer
        failedJobs:
          type: integer
        byType:
          type: object
          required:
            - agentRun
            - toolExecute
          properties:
            agentRun:
              $ref: '#/components/schemas/HealthQueueLane'
            toolExecute:
              $ref: '#/components/schemas/HealthQueueLane'
    MigrationState:
      type: object
      required:
        - status
        - pendingCount
        - appliedCount
        - errorMessage
      properties:
        status:
          type: string
        pendingCount:
          type: integer
        appliedCount:
          type: integer
        errorMessage:
          type:
            - string
            - 'null'
    HealthQueueLane:
      type: object
      required:
        - queued
        - running
        - completed
        - failed
      properties:
        queued:
          type: integer
        running:
          type: integer
        completed:
          type: integer
        failed:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````