Add OpenAI Compatibility docs#15
Merged
Merged
Conversation
Document the OpenAI-compatible chat endpoint: setup (base URL, bearer key, model), image inputs (base64 data URLs), multi-turn, streaming (with include_usage), reasoning, the parameter reference, and the models endpoint, with Python/Node/curl examples. Add it to the sidebar after the API page and cross-link from the API reference.
Match /v1/models and note the moondream/ prefix is optional (moondream3-preview also works).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
New OpenAI Compatibility page (
docs/openai.md) for the/v1/chat/completionsendpoint:https://api.moondream.ai/v1, bearer-token auth,moondream-3model (Python / Node.js / curl).stream_options.include_usage), and reasoning (message.reasoning)./v1/modelsendpoint.Added to the sidebar after API and cross-linked from the API reference. Examples were exercised against the live endpoint with the OpenAI Python SDK;
docusaurus buildpasses clean.