---
title: "Health check"
description: "Returns service health status, version, commit, and build time."
---

> Documentation Index
> Fetch the complete documentation index at: https://staging.threadapi.dev/llms.txt
> Use this file to discover all available pages before exploring further.

Path: ThreadAPI API › System

`GET /api/v1/health`

Returns service health status, version, commit, and build time.

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.threadapi.dev/api/v1/health
```

### TypeScript

```typescript
const url = 'https://api.threadapi.dev/api/v1/health';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.threadapi.dev/api/v1/health"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Service is healthy

#### Example

```json
{
  "status": "ok",
  "service": "core-go",
  "timestamp": "2026-10-23T12:00:00Z",
  "version": "dev",
  "commit": "dev",
  "build_time": "dev"
}
```

- `status` (`getHealth.response.200.status`; string, required)
  - example `"ok"`
- `service` (`getHealth.response.200.service`; string, required)
  - example `"core-go"`
- `timestamp` (`getHealth.response.200.timestamp`; string, required)
  - format `date-time`; example `"2026-10-23T12:00:00Z"`
- `version` (`getHealth.response.200.version`; string, required)
  - example `"dev"`
- `commit` (`getHealth.response.200.commit`; string, required)
  - example `"dev"`
- `build_time` (`getHealth.response.200.build_time`; string, required)
  - example `"dev"`


Source: https://staging.threadapi.dev/api/System/getHealth/index.md
