Ymi API Documentation

This page documents the public health-check endpoint exposed by the Ymi API. The complete machine-readable API definition is available in the OpenAPI specification.

Health check

Use this endpoint to check whether the production API is responding:

GET https://api.ymi.app/api/health

A successful response uses HTTP 200 and returns a JSON object with a status field and a service field.

{
  "status": "ok",
  "service": "ymi-api"
}

OpenAPI specification

View or download the Ymi API OpenAPI 3.0.3 document. It describes the production server and the health-check response schema.