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

Returns the health status of the CyborgDB service, to check that it is reachable and running.

```typescript theme={null}
async getHealth(): Promise<HealthResponse>
```

### Returns

`Promise<HealthResponse>`, an object with these keys:

| Key | Description |
| - | - |
| `status` | Service health, `'healthy'` when the service is up. |
| `api_version` | REST API version, e.g. `'v1'`. |
| `version` | CyborgDB service version. |

### Exceptions

<AccordionGroup>
  <Accordion title="CyborgDBServiceError">
    The service returns `5xx`.
  </Accordion>

  <Accordion title="CyborgDBTransportError">
    The service can't be reached.
  </Accordion>
</AccordionGroup>

See [Errors](../errors) for the full hierarchy.

### Example Usage

```typescript theme={null}
import { Client } from 'cyborgdb';

const client = new Client({ baseUrl: 'http://localhost:8000', apiKey: 'your-api-key' });

const health = await client.getHealth();
console.log(health);
// Output: { status: 'healthy', api_version: 'v1', version: '0.18.0' }
```


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