docs: add an API key setup guide for every LLM provider - #269
Merged
himanshu231204 merged 2 commits intoAug 1, 2026
Merged
Conversation
Add a single reference page that lists the exact environment variable each hosted LLM provider reads, where to get each key, and a minimal config.yaml example. Register the page under the LLM providers section in mkdocs.yml. Co-Authored-By: Kimi K2.7 Code <noreply@kimi.com>
|
🎉 Congratulations @Nitjsefnie! Your pull request has been successfully merged into main. 🚀 Thank you for contributing to OpenAgentHQ and helping improve the project. We truly appreciate your contribution and hope to see you back with more amazing PRs! Happy Open Sourcing! ❤️ |
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
2 participants
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.
Description
Closes #110. Adds
docs/providers/llm/api-key-setup.md— one section per provider with the exact environment variable the code reads, where to get the key, and a minimal working example.Every variable and default model was read out of the provider source, not from general knowledge, because a key guide that names a variable the code does not read is worse than no guide — it sends people to set something that has no effect. The cites:
OPENAI_API_KEYgpt-4oproviders/llm/openai.py:114,:120ANTHROPIC_API_KEYclaude-sonnet-4-20250514providers/llm/anthropic.py:121GEMINI_API_KEYgemini-2.5-flashproviders/llm/gemini.py:128GROQ_API_KEYllama-3.3-70b-versatileproviders/llm/groq.py:113,:120OPENROUTER_API_KEYopenai/gpt-4o-miniproviders/llm/openrouter.py:117llama3.2base_urldefaults tohttp://localhost:11434atproviders/llm/ollama.py:108mock-modelproviders/llm/mock.py:33)Ollama and Mock are documented as keyless rather than omitted, since "which ones need no key" is exactly what a reader of this page is trying to find out. No provider support was invented.
Type of Change
Related Issues
Closes #110
How Has This Been Tested?
mkdocs build --strictbuilds clean with the new page registered underProviders → LLMinmkdocs.yml.One honest note on that run:
--strictalso emits "pages exist in the docs directory but are not included in nav" for a set of files (01_vision.md,02_problem_statement.md,examples.md, others). Those are pre-existing and unrelated to this page — they are already unregistered onmain. I did not add them to the nav, since deciding what belongs in your navigation is your call, not a side effect of a docs PR.Generated by Claude Opus 5 (brief, review), Kimi K2.7 Code (implementation)