> ## 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.

# Get Health

Checks the health status of the CyborgDB microservice to verify connectivity and service availability.

```python theme={null}
client.get_health()
```

### Returns

`Dict[str, str]`: Health status information from the service.

### Exceptions

<AccordionGroup>
  <Accordion title="Error">
    * Throws if the health check request fails due to network connectivity issues.
    * Throws if the server is unreachable or times out.
  </Accordion>

  <Accordion title="Service Errors">
    * Throws if the CyborgDB service is unavailable or unreachable.
    * Throws if there are internal server errors on the CyborgDB service.
  </Accordion>
</AccordionGroup>

### Example Usage

```python theme={null}
health = client.get_health()
print(f"Service status: {health}")
```

### Response Fields

| Field | Type | Description |
| - | - | - |
| `status` | `string` | Current health status of the service (typically "healthy") |
| `api_version` | `string` | Version of the API interface (e.g., "v1") |
| `version` | `string` | Version of the CyborgDB application/service |


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