chatgpt / Exports / ChatGPTAPI
-
↳
ChatGPTAPI
• new ChatGPTAPI(opts)
Creates a new client wrapper around the unofficial ChatGPT REST API.
Note that your IP address and userAgent must match the same values that you used
to obtain your clearanceToken.
| Name | Type | Description |
|---|---|---|
opts |
Object |
- |
opts.accessToken? |
string |
Default Value undefined * |
opts.accessTokenTTL? |
number |
Default Value 1 hour * |
opts.apiBaseUrl? |
string |
Default Value 'https://chat.openai.com/api' * |
opts.backendApiBaseUrl? |
string |
Default Value 'https://chat.openai.com/backend-api' * |
opts.clearanceToken |
string |
= Required Cloudflare cf_clearance cookie value (see readme for instructions) |
opts.debug? |
boolean |
Default Value false * |
opts.headers? |
Record<string, string> |
Default Value undefined * |
opts.markdown? |
boolean |
Default Value true * |
opts.sessionToken |
string |
= Required OpenAI session token which can be found in a valid session's cookies (see readme for instructions) |
opts.userAgent? |
string |
Default Value Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36' * |
• get clearanceToken(): string
Gets the current Cloudflare clearance token (cf_clearance cookie value).
string
• get sessionToken(): string
Gets the current session token.
string
• get user(): User
Gets the currently signed-in user, if authenticated, null otherwise.
• get userAgent(): string
Gets the current user agent.
string
▸ closeSession(): Promise<void>
Closes the active session.
Throws
An error if it fails.
Promise<void>
▸ getIsAuthenticated(): Promise<boolean>
Promise<boolean>
true if the client has a valid acces token or false if refreshing
the token fails.
AChatGPTAPI.getIsAuthenticated
▸ initSession(): Promise<void>
Refreshes the client's access token which will succeed only if the session is valid.
Promise<void>
▸ refreshSession(): Promise<string>
Attempts to refresh the current access token using the ChatGPT
sessionToken cookie.
Access tokens will be cached for up to accessTokenTTL milliseconds to
prevent refreshing access tokens too frequently.
Throws
An error if refreshing the access token fails.
Promise<string>
A valid access token
▸ resetSession(): Promise<any>
Closes the current ChatGPT session and starts a new one.
Useful for bypassing 401 errors when sessions expire.
Throws
An error if it fails.
Promise<any>
Access credentials for the new session.
src/abstract-chatgpt-api.ts:59
▸ sendMessage(message, opts?): Promise<ChatResponse>
Sends a message to ChatGPT, waits for the response to resolve, and returns the response.
If you want to receive a stream of partial responses, use opts.onProgress.
If you want to receive the full response, including message and conversation IDs,
you can use opts.onConversationResponse or use the ChatGPTAPI.getConversation
helper.
| Name | Type | Description |
|---|---|---|
message |
string |
The prompt message to send |
opts |
SendMessageOptions |
- |
Promise<ChatResponse>
The response from ChatGPT
▸ sendModeration(input): Promise<ModerationsJSONResult>
| Name | Type |
|---|---|
input |
string |
Promise<ModerationsJSONResult>