Skip to content

Commit 154d2f2

Browse files
committed
Update docs with ChatGPT sub
1 parent 70c6e4d commit 154d2f2

4 files changed

Lines changed: 34 additions & 17 deletions

File tree

‎content/docs/authentication/chatgpt.mdx‎

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,25 @@ which requires permission to use the plan in addition to signing in.
1414
## Connect your account
1515

1616
1. Open **Settings → OpenAI Subscription**.
17-
2. Select **Sign in with ChatGPT**. If the browser cannot open, use **Copy sign-in link** and open it
17+
2. Select **Continue with ChatGPT**. If the browser cannot open, use **Copy link** and open it
1818
in your preferred browser.
1919
3. Sign into your account and authorize ChatGPT plan usage.
20-
4. Copy the **complete callback URL** from that browser's address bar and paste it into the card's
21-
callback field. Keep all query parameters; a bare code is insufficient.
22-
5. Complete the connection and select an available OpenAI model for chat.
20+
4. Sign-in completes automatically and the settings card updates. Select an available OpenAI model.
2321

24-
llms.py uses a manual callback workflow, including when self-hosted remotely. The callback page may
25-
fail to load because no loopback listener is running; copy its full address anyway and return to
26-
llms.py. A sign-in attempt expires after ten minutes; start a fresh attempt if it expires.
22+
<Screenshot src="/img/openai_auth/openai-sub-start.webp" alt="OpenAI Subscription card in Settings with Continue with ChatGPT and Copy link actions" />
23+
24+
Once connected, the card shows the signed-in account, confirms the OpenAI API key is disabled for
25+
your user, and offers **Disconnect**:
26+
27+
<Screenshot src="/img/openai_auth/openai-sub-connected.webp" alt="Connected OpenAI Subscription card showing the ChatGPT account, API key disabled, and Disconnect button" />
28+
29+
Local sign-in starts a callback listener before opening the browser. It uses port 1455 when available,
30+
or selects another port when occupied. The browser and llms.py must run on the same computer.
31+
A sign-in attempt expires after ten minutes; start a fresh attempt if it expires.
32+
33+
For a remote browser, the host can explicitly enable manual completion with
34+
`Options(automatic_callback=False)`. In that mode, paste the **complete callback URL** into the card;
35+
keep all query parameters, including state and the issued client ID.
2736

2837
If you signed in without granting plan usage, the verified identity is retained but subscription chat
2938
stays disabled. Sign in again and authorize it. Model choices come from your connected account rather
@@ -36,10 +45,13 @@ This is not unlimited usage: OpenAI applies account and app limits. Review and m
3645
[ChatGPT Settings → Usage](https://chatgpt.com/#settings/Usage); see
3746
[OpenAI's accounts and sessions guide](https://developers.openai.com/siwc/token-sharing-open-source/profiles-and-sessions).
3847

39-
Subscription requests do not silently switch to an API-key provider after an expired, invalid, or
40-
failed grant. Sign in again when instructed. Without a personal grant, a configured API key can still
41-
provide ordinary OpenAI access. Explicit non-text output modalities can use their configured API-key
42-
provider and its billing; connecting a subscription does not promise image/audio generation coverage.
48+
Connecting a ChatGPT subscription disables OpenAI API-key access for that user, including image/audio
49+
generation. Expired, invalid, or failed grants never fall back to API-key billing. Disconnect the
50+
subscription to restore the configured API key and its model catalog; other users are unaffected.
51+
52+
The subscription model list comes from OpenAI's public `/v1/models` endpoint using your OAuth token.
53+
Only entries marked `visibility: "list"` appear in the picker, in OpenAI's order; the list is cached for
54+
five minutes. See [OpenAI's model catalog guide](https://developers.openai.com/siwc/token-sharing-open-source/models-and-inference).
4355

4456
Responses stream with `store=false`; incomplete streams and provider failures are shown as failures,
4557
not successful answers. No uncertain inference is automatically restarted through a different provider.
@@ -76,8 +88,8 @@ user. On Windows, protect the data directory through the host filesystem's acces
7688

7789
| Situation | Action |
7890
| --- | --- |
79-
| Callback page will not load | Copy its complete address into Settings; there is no automatic loopback callback listener |
80-
| Callback rejected or expired | Start a fresh sign-in and use the matching complete URL in the same llms.py account |
91+
| Callback page will not load | Restart llms.py and start a fresh sign-in on the same computer as the server |
92+
| Callback rejected or expired | Start a fresh sign-in in the same llms.py account |
8193
| Signed in but cannot chat | Authorize plan usage and check OpenAI account eligibility and available models |
8294
| Requires reconnect | Complete a new public sign-in; old private grants cannot be reused automatically |
8395
| Subscription stream fails | Review the error and account limits; llms.py does not switch billing providers automatically |

‎content/docs/latest.mdx‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,16 @@ in your chat sidebar and project pickers. See [Projects](/docs/features/projects
9393
#### Connect ChatGPT to your workspace
9494

9595
The new **OpenAI Subscription** card in Settings connects your personal ChatGPT account through the
96-
public **Sign in with ChatGPT** flow. Authorize plan usage, paste the complete callback URL, and pick a
97-
model available to your account. Subscription text requests use that authorization, with account limits
98-
controlled by OpenAI; failed or expired grants do not silently switch to API-key billing.
96+
public **Sign in with ChatGPT** flow. Authorize plan usage, let local sign-in complete automatically,
97+
and pick a model available to your account. Subscription text requests use that authorization, with
98+
account limits controlled by OpenAI; failed or expired grants do not silently switch to API-key billing.
9999

100-
See [ChatGPT Sign-In](/docs/authentication/chatgpt) for setup, eligibility, manual callbacks,
100+
<ScreenshotsGallery className="mb-8" gridClass="grid grid-cols-1 md:grid-cols-2 gap-4" images={{
101+
'Continue with ChatGPT': '/img/openai_auth/openai-sub-start.webp',
102+
'Connected': '/img/openai_auth/openai-sub-connected.webp',
103+
}} />
104+
105+
See [ChatGPT Sign-In](/docs/authentication/chatgpt) for setup, eligibility, local callbacks,
101106
reconnecting older grants, and disconnecting.
102107

103108
#### Gemini sources you can save, edit, and synchronize
54.6 KB
Loading
54.7 KB
Loading

0 commit comments

Comments
 (0)