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

# Health Check

> Report AI Advisor health and Mistral configuration status.

Returns:
    dict: Health report with keys:
        - status (str): "healthy" if MISTRAL_API_KEY is set, otherwise "configuration_needed".
        - services (dict): Service configuration statuses; includes key "mistral" with value "configured" or "not_configured".
        - message (str): Human-readable guidance: "AI Advisor backend is ready" if configured, otherwise "Please configure MISTRAL_API_KEY".



## OpenAPI

````yaml https://api.loyalty.dog/openapi.json get /api/ai-advisor
openapi: 3.1.0
info:
  title: LoyaltyDog
  description: >-

    Welcome to the LoyaltyDog API! This API provides access to our loyalty
    program features, allowing you to integrate with various platforms and
    manage your loyalty data.


    Want to query LoyaltyDog via an AI assistant (Claude, Cursor, Windsurf)? See
    the [MCP Integration guide](https://loyaltydog.ai/playground#mcp).
        
  termsOfService: https://loyalty.dog/loyalty-program-terms-service
  contact:
    name: LoyaltyDog Support
    url: https://loyalty.dog/contact-us
    email: support@loyalty.dog
  version: 1.0.1
servers:
  - url: https://api.loyalty.dog
    description: Production
security:
  - bearerAuth: []
paths:
  /api/ai-advisor:
    get:
      tags:
        - AI Advisor
      summary: Health Check
      description: |-
        Report AI Advisor health and Mistral configuration status.

        Returns:
            dict: Health report with keys:
                - status (str): "healthy" if MISTRAL_API_KEY is set, otherwise "configuration_needed".
                - services (dict): Service configuration statuses; includes key "mistral" with value "configured" or "not_configured".
                - message (str): Human-readable guidance: "AI Advisor backend is ready" if configured, otherwise "Please configure MISTRAL_API_KEY".
      operationId: health_check_api_ai_advisor_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token obtained from POST /v2/token.

````