llama-stack-mirror/docs/source
Ben Browning e9d9f01b8b
docs: Add OpenAI API compatibility page (#2316)
# What does this PR do?

This adds some initial content documenting our OpenAI compatible APIs
- Responses, Chat Completions, Completions, and Models - along with
instructions on how to use them via OpenAI or Llama Stack clients and
some simple examples for each.

It's not a lot of content, but it's a start so that users have some idea
how to get going as we continue to work on these APIs.


## Test Plan

I generated the docs site locally and verified things render properly. I
also ran each code example to ensure it works as expected. And, I asked
my AI code assistant to do a quick spell-check and review of the docs
and it didn't flag any obvious errors.

---------

Signed-off-by: Ben Browning <bbrownin@redhat.com>
Co-authored-by: Francisco Arceo <farceo@redhat.com>
2025-06-04 06:51:52 -04:00
..
building_applications docs(mcp): add a few lines for how to specify Auth headers in MCP tools (#2336) 2025-06-02 14:28:38 -07:00
concepts docs(mcp): add a few lines for how to specify Auth headers in MCP tools (#2336) 2025-06-02 14:28:38 -07:00
contributing docs: revamp testing documentation (#2155) 2025-05-13 11:28:29 -07:00
distributions chore(ui): use proxy server for backend API calls; simplified k8s deployment (#2350) 2025-06-03 14:57:10 -07:00
getting_started docs: Add missing dependencies in quickstart demo command (#2347) 2025-06-03 18:01:36 +02:00
introduction docs: Remove mentions of focus on Llama models (#1690) 2025-03-19 00:17:22 -04:00
openai docs: Add OpenAI API compatibility page (#2316) 2025-06-04 06:51:52 -04:00
playground chore: simplify running the demo UI (#1907) 2025-04-09 11:22:29 -07:00
providers docs: add post training to providers list (#2280) 2025-05-28 09:32:00 -04:00
references chore: remove last instances of code-interpreter provider (#2143) 2025-05-12 10:54:43 -07:00
conf.py fix: use pypi browser agent (#2260) 2025-05-24 23:26:30 -07:00
index.md docs: Add OpenAI API compatibility page (#2316) 2025-06-04 06:51:52 -04:00