Skip to main content
Before writing integration code that depends on a specific API feature — streaming, usage reporting in streams, legacy completions — call GET /v1/capabilities to verify the feature is live in the environment you’re targeting. The endpoint returns a flat compatibility object you can interrogate programmatically, making it a reliable runtime guard against assumptions about what the gateway supports.

GET /v1/capabilities

Returns an API-level compatibility matrix for the Piramyd gateway. No authentication is required — call it before you have a key, from a health check, or from an integration test. Authentication: None (public endpoint)

Response shape

Response fields

string
Always "piramyd-api". Use this to confirm you are talking to the Piramyd gateway and not a passthrough or proxy.
string
The active API version — currently "v1". Use this to detect version upgrades in long-running integrations.
object
Map of feature flags. Each key represents an API capability; the boolean value indicates whether that capability is currently available.

Compatibility flags

A false value means the feature is not currently available — not that it will never exist. Check GET /v1/capabilities at startup rather than assuming flags are stable between deployments.

Check capabilities at startup


Public Status Endpoints

Piramyd exposes several no-auth status and statistics endpoints. Use them in health probes, dashboards, and integration monitors without provisioning a key.

GET /v1/status/runtime

Returns active node count, active model count, and gateway uptime. Useful for lightweight health checks in infrastructure monitoring. Authentication: None

GET /v1/status/models

Returns per-model health status, refreshed every 5 minutes. Check this endpoint to detect upstream provider degradations before sending inference requests. Authentication: None Example response (abbreviated):
Poll GET /v1/status/models in your model-selection logic to skip models with a "degraded" or "unavailable" status before you commit to a request. Combine with the capability flags from supports_tools and supports_vision in GET /v1/models for a fully runtime-driven routing strategy.

GET /v1/stats/tokens

Returns global public token totals across all users and models. No authentication required. Authentication: None

GET /v1/stats/tokens/leaderboard

Returns global token totals broken down per model, plus anonymized top-user statistics. Useful for understanding which models are most active on the platform. Authentication: None

GET /health

Performs a full gateway health check including circuit breaker status. Returns a structured object indicating whether each internal subsystem (routing, upstream providers, web intelligence services) is operational. Authentication: None Use GET /health — rather than a model inference call — as your readiness probe in container orchestration environments. It’s fast, free, and gives you circuit breaker state alongside the basic up/down signal.