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

# Health Check

> API endpoint to verify service availability and database connection

## Example Usage

For complete API documentation and examples, please refer to your [Swagger UI](https://localhost:8080/docs#/).

```bash theme={null}
curl -X 'GET' \
  'https://localhost:8080/health' \
  -H 'accept: application/json'
```


## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: codenull-ai-backend
  version: 0.1.0
servers: []
security: []
paths:
  /health:
    get:
      tags:
        - health-check
      summary: Health Check
      operationId: api-health_check
      parameters:
        - name: mongo_db_check
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            default: 1
            title: Mongo Db Check
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponseModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    APIResponseModel:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was successful.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: A brief message about the response.
        data:
          anyOf:
            - {}
            - type: 'null'
          title: Data
          description: The payload of the response.
        error:
          anyOf:
            - $ref: '#/components/schemas/ErrorResponse'
            - type: 'null'
          description: Detailed error information, if applicable.
      type: object
      required:
        - success
      title: APIResponseModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorResponse:
      properties:
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: A human-readable error message.
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: A string indicating the type/category of the error.
        param:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Param
          description: The parameter(s) associated with the error, if applicable.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: A machine-readable error code.
      type: object
      title: ErrorResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````