Skip to content

docs: add OpenAI-compatible API server documentation#437

Open
JasonOA888 wants to merge 1 commit intomicrosoft:mainfrom
JasonOA888:docs/openai-compatible-api-server
Open

docs: add OpenAI-compatible API server documentation#437
JasonOA888 wants to merge 1 commit intomicrosoft:mainfrom
JasonOA888:docs/openai-compatible-api-server

Conversation

@JasonOA888
Copy link

Addresses #432, Fixes #435

Summary

  • Document the built-in llama-server HTTP endpoint
  • Provide OpenAI-compatible API usage examples
  • Fix typo: 'will coming' -> 'will be coming'

Changes

  • README.md: Added 'OpenAI-Compatible API Server' section
  • README.md: Fixed NPU support description typo

Why This Matters

Users don't know BitNet includes an OpenAI-compatible API server. This enables:

  • Drop-in replacement for OpenAI API
  • Integration with LangChain, Open WebUI, etc.

Test plan

  • Verified llama-server binary exists
  • Tested curl examples
  • Verified Python SDK integration

Addresses microsoft#432

## Summary
- Document the built-in llama-server HTTP endpoint
- Provide OpenAI-compatible API usage examples
- Fix typo: 'will coming' -> 'will be coming'
- Enable drop-in integration with LangChain, Open WebUI, etc.

## Changes
- README.md: Added 'OpenAI-Compatible API Server' section
- README.md: Fixed NPU support description typo

## Why This Matters
Users don't know that BitNet includes a fully OpenAI-compatible API server. This documentation enables:
- Drop-in replacement for OpenAI API in existing tools
- Persistent model loading (no cold-start per request)
- Integration with job queues and proxy layers

## Test Plan
- [x] Verified llama-server binary exists in build/bin/
- [x] Tested curl examples against running server
- [x] Verified Python SDK integration
- [x] Checked LangChain example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant