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

# Health Check

### Haiqu Health Check

#### Haiqu.health\_check(api\_access\_key=None, edge\_uri=None)

Check the connection to the Haiqu cloud environment and print a report.

* **Parameters:**
  * **api\_access\_key** (*str* *|* *None*) -- The token to access the Haiqu API. Optional in the Haiqu Lab environment. Defaults to
    `None`, in which case the value will be taken from the `HAIQU_API_KEY` environment
    variable.
  * **edge\_uri** (*str* *|* *None*) -- The network location of the Haiqu API service. Defaults to `None`, in which case the value
    is taken from the `HAIQU_EDGE_URI` environment variable if set, and otherwise from the
    default production endpoint.
* **Return type:**
  None

#### Examples

```python theme={null}
>>> haiqu.health_check()
Haiqu health check: https://api.haiqu.ai/
  [OK]    environment     haiqu-sdk 1.7.0, Python 3.12.4, macOS-15.6
  [OK]    api_reachable   Haiqu API 1.6.0 responded in 512 ms
  [SKIP]  authentication  Pass api_access_key to also check your API key or set the HAIQU_API_KEY environment variable
```

```python theme={null}
>>> haiqu.health_check(api_access_key="HAIQU123")
Haiqu health check: https://api.haiqu.ai/
  [OK]    environment     haiqu-sdk 1.7.0, Python 3.12.4, macOS-15.6
  [OK]    api_reachable   Haiqu API 1.6.0 responded in 498 ms
  [OK]    authentication  API key accepted for example@haiqu.ai
```


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