Bifrost Health API

Gateway health and status endpoints

Operations 1

GET /health Bifrost Get Health #

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/bifrost-health-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.

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

OpenAPI Specification

bifrost-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bifrost HTTP Gateway Chat Health API
  description: The Bifrost HTTP Gateway API provides an OpenAI-compatible RESTful interface that routes requests to any of 20+ supported AI providers through a single unified endpoint. Requests specify the provider and model using the format provider/model-name in the model field, enabling seamless provider switching without client code changes.
  version: v1
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: Bifrost Community
    url: https://github.com/maximhq/bifrost
  x-generated-from: documentation
servers:
- url: http://localhost:8080
  description: Bifrost HTTP Gateway (default local port 8080)
tags:
- name: Health
  description: Gateway health and status endpoints
paths:
  /health:
    get:
      operationId: getHealth
      summary: Bifrost Get Health
      description: Returns the health status of the Bifrost gateway.
      tags:
      - Health
      responses:
        '200':
          description: Gateway is healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              examples:
                GetHealth200Example:
                  summary: Default getHealth 200 response
                  x-microcks-default: true
                  value:
                    status: ok
                    version: v1.0.0
                    providers:
                    - name: openai
                      status: healthy
                    - name: anthropic
                      status: healthy
                    - name: cohere
                      status: healthy
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ProviderStatus:
      title: Provider Status
      description: Status of a configured AI provider.
      type: object
      properties:
        name:
          type: string
          description: Provider name.
          example: openai
        status:
          type: string
          description: Provider health status.
          enum:
          - healthy
          - degraded
          - unavailable
          example: healthy
    HealthResponse:
      title: Health Response
      description: Gateway health status response.
      type: object
      properties:
        status:
          type: string
          description: Overall gateway status.
          example: ok
        version:
          type: string
          description: Gateway version.
          example: v1.0.0
        providers:
          type: array
          description: Status of configured providers.
          items:
            $ref: '#/components/schemas/ProviderStatus'
  securitySchemes:
    BifrostProviderAuth:
      type: apiKey
      in: header
      name: x-bf-provider-key
      description: Provider API key passed as x-bf-provider-key header. Alternatively, provider keys can be configured server-side in bifrost configuration.