docs: Add LLM subscriptions guide for OpenAI ChatGPT subscription authentication#267
Merged
docs: Add LLM subscriptions guide for OpenAI ChatGPT subscription authentication#267
Conversation
…hentication This adds documentation for the new subscription_login() feature that allows users to authenticate with their ChatGPT Plus/Pro subscription to access Codex models without consuming API credits. Key features documented: - OAuth PKCE authentication flow - Credential caching and automatic token refresh - Supported models (gpt-5.2-codex, gpt-5.2, gpt-5.1-codex-max, gpt-5.1-codex-mini) - Configuration options (force_login, open_browser) - Credential storage location Related SDK PR: OpenHands/software-agent-sdk#1682 Co-authored-by: openhands <openhands@all-hands.dev>
5 tasks
…tion - Fix subscription_login example path from 34 to 35 - Add vendor='openai' parameter to all code examples - Update code to match actual SDK example - Add new critic.mdx documentation for 34_critic_example.py - Add critic page to Agent Features navigation group Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Author
|
@OpenHands merge from main and resolve the conflict. KEEP critic docs from main, and only add the new llm subscription docs |
|
I'm on it! xingyaoww can track my progress at all-hands.dev |
Keep critic docs from main, preserve new llm-subscriptions docs Co-authored-by: openhands <openhands@all-hands.dev>
|
I've successfully merged main into the Summary of ChangesConflict Resolution:
Final Diff (compared to main):
The changes have been pushed to the remote branch |
xingyaoww
commented
Feb 2, 2026
…quickstart - Update credential storage path from ~/.local/share/openhands/auth/ to ~/.openhands/auth/ to match SDK PR #1682 - Fix example directory name from agent-sdk to software-agent-sdk - Add ChatGPT Subscription as third option in how-to-run-example.mdx - Add Tip component linking to LLM Subscriptions guide Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
commented
Feb 2, 2026
Remove code block for ChatGPT subscription option and keep it as a Tip component that links to the LLM Subscriptions guide. Co-authored-by: openhands <openhands@all-hands.dev>
- Add import for RunExampleCode shared snippet - Add 'ready-to-run example' link at top - Restructure 'How It Works' section using Steps/Step components - Move 'Ready-to-run Example' section to end (before Next Steps) - Add RunExampleCode component after code block - Add icon='python' to all code blocks Co-authored-by: openhands <openhands@all-hands.dev>
- Remove OAuth PKCE flow details (keep it high-level) - Remove Automatic Token Management step (merge into step 2) - Simplify Credential Storage section Co-authored-by: openhands <openhands@all-hands.dev>
…GENTS.md - Add Option 3: ChatGPT Subscription to getting-started.mdx AccordionGroup - Add 'LLM API Key Options' section to AGENTS.md documenting the three ways users can obtain LLM access for future reference Co-authored-by: openhands <openhands@all-hands.dev>
enyst
reviewed
Feb 2, 2026
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
|
Looks like there are a few issues preventing this PR from being merged!
If you'd like me to help, just leave a comment, like Feel free to include any additional details that might help me get this PR into a better state. You can manage your notification settings |
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
3 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.
Summary
This PR adds documentation for the new
LLM.subscription_login()feature that allows users to authenticate with their ChatGPT Plus/Pro subscription to access Codex models without consuming API credits.Related SDK PR: OpenHands/software-agent-sdk#1682
Changes
sdk/guides/llm-subscriptions.mdxdocs.jsonto include the new page in the "LLM Features" navigation groupDocumentation Covers
~/.local/share/openhands/auth/gpt-5.2-codex(default)gpt-5.2gpt-5.1-codex-maxgpt-5.1-codex-miniforce_login- Force fresh OAuth loginopen_browser- Control browser auto-open behaviorNote
OpenAI subscription is the first provider supported. The documentation is structured to accommodate future subscription providers as they are added.
@xingyaoww can click here to continue refining the PR