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

# Health Check

> Check API and service health status

Check the health status of the Public Records API and all dependent services. No authentication required.

## Response

<ResponseField name="status" type="string">
  Overall API status: `healthy` or `unhealthy`
</ResponseField>

<ResponseField name="service" type="string">
  Service name: `eval-framework`
</ResponseField>

<ResponseField name="services" type="object">
  Health status of dependent services (each `true` or `false`)

  <Expandable title="Service Properties">
    <ResponseField name="xml_transformer" type="boolean">
      XML processing service status
    </ResponseField>

    <ResponseField name="compliance_engine" type="boolean">
      Compliance evaluation service status
    </ResponseField>
  </Expandable>
</ResponseField>

## Example Request

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://cra.pr.snh-ai.com/health"
  ```

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

  response = requests.get("https://cra.pr.snh-ai.com/health")
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch("https://cra.pr.snh-ai.com/health");
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

## Example Response

```json theme={null}
{
  "status": "healthy",
  "service": "eval-framework",
  "services": {
    "xml_transformer": true,
    "compliance_engine": true
  }
}
```

When one or more services are down, `status` returns `"degraded"`:

```json theme={null}
{
  "status": "degraded",
  "service": "eval-framework",
  "services": {
    "xml_transformer": true,
    "compliance_engine": false
  }
}
```

## Usage

* Verify API availability before sending evaluation requests
* Monitoring and alerting integration
* Pre-flight checks in your integration workflow

## Related

* [API Overview](/api-reference/overview) — Complete API documentation
* [Environments](/environments) — Base URLs and usage guidelines