🔌 API Documentation

Returns a beautiful HTML documentation page with API status.

Response

HTML page with API documentation and status

Check API status and currently loaded model.

Response

{
  "status": "ok",
  "model": "phi-3-mini-4k-instruct.Q4_K_M.gguf",
  "version": "1.0.0"
}

List all downloaded models available for use.

Response

{
  "object": "list",
  "data": [
    {
      "id": "phi-3-mini-4k-instruct.Q4_K_M.gguf",
      "object": "model",
      "owned_by": "kairos-local"
    }
  ]
}

Send a message and receive a complete response (non-streaming).

Request Body

Example Request

curl -X POST http://localhost:5000/chat \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      { "role": "user", "content": "Hello!" }
    ]
  }'

Response

{
  "model": "phi-3-mini-4k-instruct.Q4_K_M.gguf",
  "content": "Hello! How can I help you today?",
  "token_count": 8
}

Send a message and receive a streaming response (Server-Sent Events).

Request Body

Same as /chat

Example Request

curl -X POST http://localhost:5000/chat/stream \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Hello!"}]}'

Response (SSE Stream)

data: {"content": "Hello"}

data: {"content": "!"}

data: {"content": " How"}

data: {"content": " can"}

data: [DONE]

503 - No Model Loaded

{
  "error": {
    "message": "No model loaded. Please load a model first.",
    "type": "invalid_request_error"
  }
}

400 - Invalid Request

{
  "error": {
    "message": "Messages array is required",
    "type": "invalid_request_error"
  }
}