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

# Health Check

Check if the API service is running and accessible.

## Parameters

None

## Authentication

Not required

## Response

```json theme={null}
{
  "status": "healthy",
  "api_version": "v1",
  "version": "0.17.0"
}
```

### Response Fields

| Field | Type | Description |
| - | - | - |
| `status` | `string` | Health status of the service (always `"healthy"` if responding) |
| `api_version` | `string` | Current API version |
| `version` | `string` | Application version number |

## Example Usage

```bash theme={null}
curl http://localhost:8000/v1/health

# Or with HTTPS
curl https://your-domain.com:8000/v1/health
```

## Use Cases

* **Health monitoring**: Check if the service is operational
* **Load balancer checks**: Verify service availability
* **Deployment validation**: Confirm successful service startup
* **Network connectivity**: Test basic API accessibility


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.