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

# Health Check

> Health check endpoint for monitoring and load balancers.

Returns ``status: "ok"`` only when an agent is registered and
``/agent/*`` will accept requests. Returns ``status: "degraded"`` with
``agent_ready: false`` when no agent is configured — e.g. standalone
admin-only mode after an ``assemble_engine_config`` error, or the
pre-onboarding wizard state. When ``app.state.boot_error`` is set by
the standalone's assembly failure handler, it is surfaced as ``reason``
so operators can diagnose without grepping logs.



## OpenAPI

````yaml /standalone/openapi.json get /health
openapi: 3.1.0
info:
  title: Idun Agent Engine Server
  description: A production-ready server for conversational AI agents
  version: 0.6.1
servers: []
security: []
tags:
  - name: Runtime
    description: >-
      Public agent run endpoints, engine operations, and chat-channel webhooks.
      SSE streaming via the AG-UI protocol.
  - name: Agent Configuration
    description: >-
      Singleton admin endpoints for the agent, prompts, memory, guardrails, and
      onboarding wizard.
  - name: Auth & SSO
    description: >-
      Login, sessions, password change, SSO config, and the public SSO discovery
      endpoint.
  - name: Integrations & Tools
    description: MCP server registry and external integration credentials.
  - name: Observability
    description: Tracing/logging provider configuration.
  - name: Traces
    description: >-
      Trace and span storage admin endpoints — list, detail, delete, and
      pipeline-health for the standalone trace store.
  - name: Dashboard
    description: >-
      Operator dashboard widgets — KPIs, time-series, top errors, and
      configuration summary.
paths:
  /health:
    get:
      tags:
        - Runtime
      summary: Health Check
      description: |-
        Health check endpoint for monitoring and load balancers.

        Returns ``status: "ok"`` only when an agent is registered and
        ``/agent/*`` will accept requests. Returns ``status: "degraded"`` with
        ``agent_ready: false`` when no agent is configured — e.g. standalone
        admin-only mode after an ``assemble_engine_config`` error, or the
        pre-onboarding wizard state. When ``app.state.boot_error`` is set by
        the standalone's assembly failure handler, it is surfaced as ``reason``
        so operators can diagnose without grepping logs.
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  schemas:
    HealthResponse:
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
          title: Status
        service:
          type: string
          title: Service
        version:
          type: string
          title: Version
        agent_ready:
          type: boolean
          title: Agent Ready
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Name
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      type: object
      required:
        - status
        - service
        - version
        - agent_ready
        - agent_name
      title: HealthResponse
      description: >-
        Response shape for ``/health``.


        ``reason`` is only emitted when an assembly failure handler set

        ``app.state.boot_error``; the route uses
        ``response_model_exclude_unset``

        so the field stays absent (not ``null``) on the happy path.

````