Skip to main content
GET
/
v1
/
ping
Health check
curl --request GET \
  --url https://api.hypermid.io/v1/ping \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "status": "ok",
    "version": "1.0.0",
    "timestamp": 1711234588
  },
  "error": null,
  "meta": {
    "requestId": "d0a1b2c3-d4e5-6789-3456-890123456789",
    "timestamp": 1711234588,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1970,
      "reset": 1711234627
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt

Use this file to discover all available pages before exploring further.

Simple health check endpoint to verify the API is operational. Does not require authentication. 
{
  "data": {
    "status": "ok",
    "version": "1.0.0",
    "timestamp": 1711234588
  },
  "error": null,
  "meta": {
    "requestId": "d0a1b2c3-d4e5-6789-3456-890123456789",
    "timestamp": 1711234588,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1970,
      "reset": 1711234627
    }
  }
}

const ping = await client.ping();
console.log("API status:", ping.data.status);
console.log("Version:", ping.data.version);
Use this endpoint for uptime monitoring. It does not count against your rate limit when called without an API key.

Authorizations

​
X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Response

200 - application/json

API is healthy

​
status
string
Example:

"ok"

​
version
string
Example:

"v1"

​
uptime
integer

Server uptime in seconds

​
timestamp
integer

Unix epoch seconds

​
providers
object