---
title: "Liveness and store readiness (free)."
method: GET
path: "/v1/health"
tags: ["discovery"]
---

# Liveness and store readiness (free).

`GET /v1/health`

## Request

- Base URL: `https://cloud.trycorpus.ai`
- URL: `https://cloud.trycorpus.ai/v1/health`
- Auth: none required

Returns 200 whenever the server is up. `ready` is false while the store is still ingesting after a restart; paid endpoints answer 503 (and take no payment) until it is true.

## Response `200`

Status.

- Health
  - `ok` boolean
  - `ready` boolean: True once the store has ingested every raw file.
  - `ingest` object
    - `done` integer
    - `total` integer
    - `added` integer
    - `error` string, nullable
  - `version` string

---

[API](https://skmtc.dev/trycorpus/apis/corpusai-cloud-pricing-api.md) · [All operations](https://skmtc.dev/trycorpus/apis/corpusai-cloud-pricing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trycorpus/apis/corpusai-cloud-pricing-api/revisions/cb0754f4d151?raw)