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

# Health Check

> Check if the API is running

Simple health check endpoint for monitoring and load balancer health probes.

## Response

<ResponseField name="status" type="string">
  `"healthy"` if the API is running
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://searchcompany-main.up.railway.app/health
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "status": "healthy"
  }
  ```
</ResponseExample>

## Usage

### Railway Health Checks

Configure in `railway.toml`:

```toml theme={null}
[healthcheck]
path = "/health"
interval = 30
timeout = 10
```

### Docker Health Checks

```dockerfile theme={null}
HEALTHCHECK --interval=30s --timeout=10s \
  CMD curl -f http://localhost:8000/health || exit 1
```

### Uptime Monitoring

Use this endpoint with services like:

* UptimeRobot
* Pingdom
* Better Uptime
* Railway's built-in monitoring

## Root Endpoint

There's also a root endpoint at `/` that returns:

```json theme={null}
{
  "message": "Hello from Backend!"
}
```
