Skip to main content
These endpoints require no authentication. Use them to monitor platform availability, check which models are currently healthy, track global usage, and verify that your integration can reach the API. They are safe to call from health-check scripts, uptime monitors, and observability dashboards without exposing any credentials.

Endpoint Reference


GET /v1/status/runtime

Returns high-level runtime metrics for the Piramyd platform: the number of active nodes, how many models are currently serving traffic, and how long the service has been running. No API key required. Base URL: https://api.piramyd.cloud

Response Fields

integer
Number of inference routing nodes currently online.
integer
Number of models currently accepting requests across all nodes.
integer
Seconds elapsed since the last service restart.

Example

This endpoint is ideal as a lightweight integration health check — a successful 200 response with active_models > 0 confirms the gateway is operational before you begin routing inference requests.

GET /v1/status/models

Returns a per-model health and availability report. The data is refreshed every 5 minutes, making it suitable for dashboards and pre-flight checks but not for sub-minute monitoring. Base URL: https://api.piramyd.cloud

Response Fields

array
List of model health objects. Each entry describes one model’s current state.
string
The model ID, matching entries in GET /v1/models.
string
Current health status. Typical values: healthy, degraded, unavailable.
string
ISO 8601 timestamp of the most recent health check.

Example

Check this endpoint before routing critical requests to a specific model. If a model’s status is degraded or unavailable, switch to an alternative from GET /v1/models rather than waiting on retries.

GET /health

A lightweight health check that also exposes internal circuit breaker state. Use this as your primary ping endpoint for uptime monitoring tools (e.g. UptimeRobot, Checkly, Datadog synthetics). Base URL: https://api.piramyd.cloud A 200 OK response indicates the gateway is reachable and circuit breakers are not in a tripped state. Non-200 responses indicate a service-level problem.

Example

/health lives at the root domain (https://api.piramyd.cloud/health), not under the /v1 prefix. If you’re constructing URLs programmatically from a BASE_URL of https://api.piramyd.cloud/v1, remember to strip the prefix for this endpoint.

GET /

Returns basic service information about the API. Useful for confirming connectivity and discovering the API version in automated bootstrapping sequences. Base URL: https://api.piramyd.cloud

GET /v1/stats/tokens

Returns global public token totals across all users and models on the platform. No authentication required. Base URL: https://api.piramyd.cloud

Example

These totals reflect overall platform activity and can give you a sense of Piramyd’s traffic volume over time.

GET /v1/stats/tokens/leaderboard

Returns global token usage broken down by model, plus an anonymized list of top users by token consumption. No authentication required. Base URL: https://api.piramyd.cloud

Example

Use this endpoint to understand which models are seeing the heaviest traffic on the platform — useful context when deciding which model to prioritize for your own workloads or when researching availability patterns.
Poll GET /v1/status/models before routing requests to a specific model. If a model shows a degraded or unavailable status, fall back to an alternative from GET /v1/models immediately rather than absorbing retry latency from a struggling upstream.