osmAPI

osmAPI Health API

The OsmAPI Health API API from osmAPI — 1 operation(s) for osmapi health api.

GitHub OpenAPI

Operations 1

GET / Health check #

Documentation

📖
Documentation
https://docs.osmapi.com/v1_chat_completions
📖
Documentation
https://docs.osmapi.com/v1_messages
📖
Documentation
https://docs.osmapi.com/v1_models
📖
Documentation
https://docs.osmapi.com/health

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/osmapi/refs/heads/main/openapi/osmapi-osmapi-health-api-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osmapi-osmapi-health-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osmapi-osmapi-health-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OsmAPI Health API
  description: Health check endpoint for the osmAPI service, reporting operational status and connectivity to Redis and database dependencies.
  version: 1.0.0
  contact:
    name: osmAPI
    url: https://www.osmapi.com/
servers:
- url: https://api.osmapi.com
  description: Production
tags:
- name: OsmAPI Health API
paths:
  /:
    get:
      operationId: healthCheck
      summary: Health check
      description: Returns the health status of the osmAPI service including connectivity to Redis and database dependencies.
      parameters:
      - name: skip
        in: query
        schema:
          type: string
        description: Comma-separated list of health checks to skip (redis, database)
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Service is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      tags:
      - OsmAPI Health API
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        message:
          type: string
        version:
          type: string
        health:
          type: object
          properties:
            status:
              type: string
            redis:
              type: object
              properties:
                connected:
                  type: boolean
                error:
                  type: string
            database:
              type: object
              properties:
                connected:
                  type: boolean
                error:
                  type: string