Health

Health check

GET/health

Returns the health status of the Bifrost server. Checks connectivity to config store, log store, and vector store if configured.

Response Body

`application/json`

`application/json`

curl -X GET "http://localhost:8080/health"

{
  "status": "ok",
  "components": {
    "property1": "string",
    "property2": "string"
  }
}

{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}

Update virtual key PUT

Updates an existing virtual key's configuration.

Edit an image POST

Edits an image using a text prompt and optional mask. Request must be sent as multipart/form-data with at least model, prompt (unless type is background_removal), and image (or image[]).