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

# Health Check

> Check if the OpenFiles API is operational

# Health Check

Check the operational status of the OpenFiles API. This endpoint is useful for monitoring, load balancers, and health checks in production systems.

## Use Cases

* **System monitoring** - Check if API is responsive
* **Load balancer health checks** - Verify endpoint availability
* **Integration testing** - Confirm API connectivity
* **Status dashboards** - Monitor service uptime

## Example Usage

<CodeGroup>
  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.openfiles.ai/functions/v1/api/health')
  const health = await response.json()
  console.log(health.status) // "ok"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get('https://api.openfiles.ai/functions/v1/api/health')
  health = response.json()
  print(health['status'])  # "ok"
  ```

  ```bash cURL theme={null}
  curl 'https://api.openfiles.ai/functions/v1/api/health'
  ```
</CodeGroup>

## Response

The health check returns a simple JSON response indicating the API status.

```json theme={null}
{
  "status": "ok",
  "timestamp": "2024-01-15T10:30:00.000Z"
}
```


## OpenAPI

````yaml get /health
openapi: 3.0.0
info:
  title: OpenFiles SDK API
  description: >-
    AI-native file storage platform with create, read, write operations, version
    control, and semantic search.
  version: 2.0.0
  contact:
    name: OpenFiles Support
    url: https://openfiles.ai
servers:
  - url: https://api.openfiles.ai/functions/v1/api
    description: Production
  - url: http://localhost:54321/functions/v1/api
    description: Local Development
security: []
tags:
  - name: System
    description: System health and status operations
  - name: Files
    description: File storage operations with version control
paths:
  /health:
    get:
      tags:
        - System
      summary: Health check
      description: Check if the API service is running
      operationId: healthCheck
      responses:
        '200':
          description: Service healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - timestamp
        - message
        - version
      properties:
        status:
          type: string
          enum:
            - ok
          example: ok
        timestamp:
          type: string
          format: date-time
        message:
          type: string
          example: OpenFiles API
        version:
          type: string
          example: 1.0.0

````