---
title: "Service health"
method: GET
path: "/health"
---

# Service health

`GET /health`

## Request

- Base URL: `https://api.space-ocr.com`
- URL: `https://api.space-ocr.com/health`
- Auth: none declared

## Response `200`

OK

- object
  - `status` string, required
  - `version` string, required
  - `time` number, required
  - `engine` object, nullable, required
    - `version` string, nullable, required
    - `build` object, nullable, required
      - `sha` string, nullable, required
      - `deployed_at` string, nullable, required
    - `changelog` object[], nullable, required
      - `version` string, required
      - `date` string, required
      - `changes` string[], required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `413`: Payload Too Large
- `429`: Too Many Requests
- `500`: Internal Error
- `502`: OCR engine error (charge auto-refunded)
- `504`: OCR engine timeout (charge auto-refunded)

---

[API](https://skmtc.dev/space-ocr/apis/space-ocr-public-api.md) · [All operations](https://skmtc.dev/space-ocr/apis/space-ocr-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/space-ocr/apis/space-ocr-public-api/revisions/d7831cf1168e?raw)