health

Health

Liveness/readiness probes.

2 endpoints

GET `/api/v1/health/live`

Liveness probe — process is up.

No authenticationScopePublic

curl example

curl

curl -X GET "https://api.yourdomain.com/api/v1/health/live" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY"

Responses

200The process is running.

Name	Type	Constraints
statusrequired	enum: "ok"	—

json

{
  "status": "ok"
}

400The request could not be read at all — unparseable body, unusable content type, oversized payload (`MALFORMED_REQUEST`). Never a schema failure: those are 422.

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

401Missing, expired or invalid credentials (`UNAUTHORIZED`, `TOKEN_INVALID`, `SESSION_REVOKED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

403Authenticated, but not allowed (`FORBIDDEN`, `FEATURE_DISABLED`, `QUOTA_EXCEEDED`, …).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

404No such resource, or it is not visible to this tenant (`NOT_FOUND`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

409Conflicts with current state (`CONFLICT`, `VERSION_CONFLICT`, `IDEMPOTENCY_KEY_REUSED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

422The request was read but its content is not acceptable: body/query/path/header failed schema validation (`VALIDATION_ERROR`, with `details.issues`), or a domain rule rejected a well-formed value (`VIDEO_URL_INVALID`, …).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

429Rate limit exceeded — see the `RateLimit-*` and `Retry-After` headers (`RATE_LIMITED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

500Unexpected server error (`INTERNAL_ERROR`). Never carries a stack trace or SQL.

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

GET `/api/v1/health/ready`

Readiness probe — dependencies (Postgres, Redis) are reachable.

No authenticationScopePublic

curl example

curl

curl -X GET "https://api.yourdomain.com/api/v1/health/ready" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY"

Responses

200All dependencies are reachable.

Name	Type	Constraints
statusrequired	enum: "ok" \| "error"	—
checksrequired	object	—

json

{
  "status": "ok",
  "checks": {
    "postgres": {
      "status": "ok",
      "error": "string"
    },
    "redis": {
      "status": "ok",
      "error": "string"
    }
  }
}