---
title: "Check whether Hypamoon is working"
method: GET
path: "/status"
tags: ["Meta"]
---

# Check whether Hypamoon is working

`GET /status`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/status`
- Auth: none required

Whether Hypamoon is working, per component (sites, API, portal, phone, AI receptionist, email, payments), and any reported problem that is not resolved yet. From the public status page (https://status.hypamoon.com); when that page does not answer, a minimal check of our own. Use it when a step fails and you wonder whether Hypamoon is down: a blocked upload_url or a network error from your own environment is not an outage. user_message is a sentence for the user. Public: no key needed.

## Response `200`

The status.

- Status: Whether Hypamoon is working, per component.
  - `status` 'operational' | 'degraded' | 'down' | 'unknown', required: The overall status: the worst of the components (unknown does not count).
  - `source` 'status_page' | 'self_check', required: status_page: from status.hypamoon.com. self_check: that page did not answer, so only a minimal check of our own.
  - `components` object[], required: Per component: sites, api, portal, phone, ai, mail, payments.
    - `id` string, required
    - `name` string, required
    - `status` 'operational' | 'degraded' | 'down' | 'unknown', required
  - `incidents` object[], required: Reported problems that are not resolved yet.
    - `component` string, required
    - `severity` string, required
    - `started_at` string, required
    - `latest_update` string, nullable, required
  - `status_page` string, required: The public status page.
  - `checked_at` string, required: When the status was measured.
  - `user_message` string, required: One calm sentence for the user, like "Hypamoon is working normally. The problem is likely in your chat app."
  - `next_step` string, required: What the chat or agent should do next.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)