---
title: "Check readiness"
method: GET
path: "/api/health/ready"
---

# Check readiness

`GET /api/health/ready`

## Request

- Base URL: `https://www.toma.com`
- URL: `https://www.toma.com/api/health/ready`
- Auth: none required

Returns 200 when the database answers, 503 when it doesn't. Reports configured sign-in methods and the search mode (hybrid with the search index, keyword without it). No secrets.

## Response `200`

The database answered.

- object
  - `status` 'ok' | 'unavailable', required
  - `database` boolean, required
  - `signIn` object, required
    - `linkedin` boolean
    - `google` boolean
    - `magicLink` boolean
  - `search` 'hybrid' | 'keyword', required
  - `personalFiles` boolean, required: An object-store connector is configured for owner-only files; this does not probe storage permissions.
  - `taskFiles` boolean, required: An object-store connector is configured; this does not probe storage permissions.

## Other responses

- `503`: The database did not answer.

---

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