chatgpt / Exports / ChatGPTAPI
• new ChatGPTAPI(opts)
Creates a new client wrapper around the unofficial ChatGPT REST API.
| Name | Type | Description |
|---|---|---|
opts |
Object |
- |
opts.accessToken? |
string |
- |
opts.accessTokenTTL? |
number |
Default Value 60000 (60 seconds) |
opts.apiBaseUrl? |
string |
Default Value 'https://chat.openai.com/api' * |
opts.backendApiBaseUrl? |
string |
Default Value 'https://chat.openai.com/backend-api' * |
opts.clearanceToken |
string |
- |
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/107.0.0.0 Safari/537.36' * |
• get user(): User
Gets the currently signed-in user, if authenticated, null otherwise.
▸ ensureAuth(): Promise<string>
Refreshes the client's access token which will succeed only if the session is still valid.
Promise<string>
▸ getConversation(opts?): ChatGPTConversation
Gets a new ChatGPTConversation instance, which can be used to send multiple messages as part of a single conversation.
| Name | Type | Description |
|---|---|---|
opts |
Object |
- |
opts.conversationId? |
string |
Optional ID of the previous message in a conversation |
opts.parentMessageId? |
string |
Optional ID of the previous message in a conversation |
The new conversation instance
▸ getIsAuthenticated(): Promise<boolean>
Promise<boolean>
true if the client has a valid acces token or false if refreshing
the token fails.
▸ refreshAccessToken(): 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
▸ sendMessage(message, opts?): Promise<string>
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<string>
The response from ChatGPT