@openstatus/health-openai

OpenAI probe for @openstatus/health. Sends GET {baseUrl}/v1/models with your API key as a bearer header, so it proves both that the API answers and that the key is valid — with fetch alone, on every runtime, and without spending a single token.

deno add jsr:@openstatus/health jsr:@openstatus/health-openai
npm install @openstatus/health @openstatus/health-openai

import { createHealthHandler, readEnv } from "@openstatus/health";
import { openaiProbe } from "@openstatus/health-openai";

const apiKey = readEnv("OPENAI_API_KEY");

Deno.serve(
  createHealthHandler({
    probes: [
      // the factory validates `apiKey` at construction, so pass a
      // placeholder and let `skip` keep the unconfigured check from running.
      openaiProbe({
        apiKey: apiKey || "unconfigured",
        skip: () => !apiKey,
      }),
    ],
  }),
);

apiKey is the sk-… key from the OpenAI dashboard; a project key with the Models read permission is enough. Listing models is a free read with no side effects and no rate-limit cost worth mentioning, so the probe can run on every health request. baseUrl defaults to https://api.openai.com and takes the origin of any OpenAI-compatible server — Azure OpenAI, a gateway or a local model server — as long as it serves /v1/models. Like every probe here, this one never reads the environment itself — pass the values in, and use skip for environments where OpenAI is not configured.

A 2xx here means the API is up and the key authenticates. It does not prove that a specific model is available or that completions are within their rate limit; a model-level outage shows up in your request errors before it shows up here.

openaiProbe({
  apiKey: apiKey || "unconfigured",
  // optional overrides from the Probe contract
  name: "llm",
  critical: true,
  timeoutMs: 2000,
  skip: () => !apiKey,
});

Non-critical by default: most services can answer without a model call, so an outage degrades the report instead of taking the service out of rotation. Set critical: true for a service whose every request is an inference.

About openstatus

openstatus is the open-source uptime monitoring and status page platform. This package is part of @openstatus/health, the /health endpoints behind openstatus's own services, extracted so any JavaScript server can expose one. Point an openstatus monitor at the endpoint and assert on status in the body to be alerted on degraded before it becomes unhealthy.

Source: github.com/openstatusHQ/health. Issues and PRs welcome.

License

MIT